Skip to content

Commit 9b58410

Browse files
authored
Create CONTRIBUTING.md
1 parent 59a810c commit 9b58410

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing Guidelines
2+
3+
Thank you for considering contributing to this project! We appreciate your effort to make this project better.
4+
5+
To contribute, please follow these guidelines:
6+
7+
## Issue Tracker
8+
9+
- Before creating a new issue, please search the existing issues to avoid duplicates.
10+
- If you find an issue that matches your problem, feel free to add any additional information or context as a comment.
11+
12+
## Bug Reports
13+
14+
- When reporting a bug, please provide a clear and detailed description of the issue.
15+
- Include steps to reproduce the bug, if possible.
16+
- If applicable, include error messages or screenshots.
17+
18+
## Feature Requests
19+
20+
- Feel free to suggest new features or enhancements.
21+
- Provide a detailed description of the feature and why it would be valuable.
22+
- Explain how the feature aligns with the project's goals and objectives.
23+
24+
## Pull Requests
25+
26+
We welcome pull requests from the community. To submit a pull request:
27+
28+
1. Fork the repository and create your branch from `master`.
29+
2. Ensure that your code follows the project's coding conventions.
30+
3. Write clear commit messages.
31+
4. Include any necessary tests and ensure that all tests pass.
32+
5. Provide a description of the changes made in the pull request.
33+
34+
## Coding Conventions
35+
36+
- Follow the existing coding style and conventions used in the project.
37+
- Use meaningful variable and function names.
38+
- Write clear and concise comments when necessary.
39+
- Keep lines within a reasonable length for readability.
40+
41+
## License
42+
43+
By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).
44+
45+
## Code of Conduct
46+
47+
Please note that this project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code of conduct. Please report any unacceptable behavior to the project maintainers.
48+
49+
---

0 commit comments

Comments
 (0)