You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for considering contributing to this project! To help maintain a healthy and productive environment, please follow these basic guidelines.
4
+
5
+
## Creating Issues
6
+
7
+
Here are the minimum requirements for creating a issue on this project.
8
+
**Any issue with a too vague description or inappropriate language may be closed without notice**: it often takes orders of magnitude more time to answer theses than the time it took for the author to write them.
9
+
10
+
### 1. Clear and Descriptive Title
11
+
The title should give a quick understanding of what the issue is about.
12
+
13
+
Examples:
14
+
- ✅ "TypeError when processing empty strings"
15
+
- ✅ "Documentation unclear about parameter X usage"
16
+
- ❌ "It doesn't work"
17
+
- ❌ "Bad implementation"
18
+
19
+
### 2. Meaningful Description
20
+
Your description should help others understand your issue. While the format is flexible, please make sure to convey:
21
+
- What you're trying to do
22
+
- What's not working as expected
23
+
- Any relevant context that could help understand the situation
24
+
25
+
The key is being clear and providing enough information so others can understand and help you.
26
+
27
+
### 3. Respectful Communication
28
+
Remember that open source maintainers are volunteers working on this project in their free time. Please:
29
+
- Be respectful and constructive (there is no "it should be like this", or "this is bad"...)
30
+
- Understand that the project spirit may not align with your expectations
31
+
32
+
## Submitting a Pull Request
33
+
34
+
Pull requests are welcome! Make sure to properly explain the changes you're proposing in an issue, especially for significant changes.
0 commit comments