Creating a well-written issue greatly helps those who will solve the problem or implement the idea. Here's a simple and straightforward guide:
1. Use a Template
Whenever possible, use an issue template. Example of how to create an issue with a template:
2. Create a good title
The title should be direct and standardized. Examples:
- [BUG] Error type in functions
- [FEATURE] Add lists
- [DOCS] Improve docs in parser
Avoid vague titles like:
"Doesn't work"
"Strange bug"
3. Describe well
The more details, the better:
- What happened
- When it happened
- How to reproduce it
- What you expected
Final Tip
A good issue = less time wasted + faster resolution
Creating a well-written issue greatly helps those who will solve the problem or implement the idea. Here's a simple and straightforward guide:
1. Use a Template
Whenever possible, use an issue template. Example of how to create an issue with a template:
2. Create a good title
The title should be direct and standardized. Examples:
Avoid vague titles like:
"Doesn't work"
"Strange bug"
3. Describe well
The more details, the better:
Final Tip
A good issue = less time wasted + faster resolution