-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCONTRIBUTING
67 lines (43 loc) · 2.54 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Contributing
First of all, thank you for taking the time to contribute! 🎉 We appreciate your efforts and are excited to work with you.
## Code of Conduct
By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please make sure to read it carefully.
## How Can I Contribute?
### Reporting Bugs
- Ensure the bug was not already reported by searching on the [issues page](https://github.com/salteadorneo/cssx/issues).
- If you're unable to find an open issue addressing the problem, open a new one.
- Please be clear and concise with your bug report, providing as much information as possible.
### Suggesting Enhancements
- Before suggesting an enhancement, ensure that it hasn't already been proposed by searching the [issues page](https://github.com/salteadorneo/cssx/issues).
- Describe the enhancement you would like to see, why it's important, and how it can benefit the project.
- If possible, provide any examples or potential implementation ideas.
### Pull Requests
We follow the "fork-and-pull" Git workflow:
1. **Fork** the repository.
2. **Clone** your forked repository locally.
3. **Create** a new branch for your feature or bugfix.
4. **Commit** your changes.
5. **Push** your branch to your fork.
6. **Open** a Pull Request in our repository.
#### Pull Request Guidelines
- Ensure that your code adheres to the project’s style guides.
- Write meaningful commit messages.
- Provide a detailed description of your changes in the Pull Request.
- Ensure all tests pass (run `npm test`, `pytest`, or the appropriate test suite for the project).
- Add tests for any new features or bug fixes.
### Coding Standards
To maintain a consistent codebase, please ensure your code follows these standards:
- Follow the project’s specific linting rules (check `.eslintrc`, `.prettierrc`, etc.).
- Make sure code is well-documented with meaningful comments.
- Keep functions and classes small and focused on one task.
### Issue Labels
We use issue labels to organize and prioritize issues. Here’s a quick breakdown:
- **bug**: Something is not working.
- **enhancement**: A new feature or request.
- **help wanted**: We need help with this issue.
- **good first issue**: Great for first-time contributors.
- **documentation**: Improvements or additions to documentation.
## Communication
Feel free to ask questions, suggest improvements, or talk with the team.
## Thank You
Thank you again for taking the time to contribute. Your help is greatly appreciated! If you have any questions or need assistance, feel free to contact us.