Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation issue template #467

Merged
merged 1 commit into from
Dec 26, 2023

Conversation

arpagon
Copy link
Contributor

@arpagon arpagon commented Dec 22, 2023

Github Issue with the following format:

  • Issue Naming Convention: Start with "Docs:", followed by a concise, descriptive title. For example, "Docs: Install Guide - Incorrect Command Syntax".
  • Brief Description: Summarize the issue, specifying where in the documentation it occurs (e.g., section, paragraph).
  • Steps to Reproduce: List steps to reproduce the issue, if applicable, especially for incorrect instructions.
  • Suggested Fix: Provide a proposed solution or improvement, like text rewrites, clarifications, or new examples.

@Kian1354 Kian1354 merged commit 9b63826 into vocodedev:main Dec 26, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants