-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathContribution Guideline
32 lines (24 loc) · 1.66 KB
/
Contribution Guideline
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
# Contribution Guidelines
Thank you for considering contributing to this project! Please adhere to the following rules to maintain the quality and integrity of the repository:
## General Rules
1. **Star the Repository**: Kindly star this repository before making contributions.
2. **Respect the Code of Conduct**: Be respectful and inclusive in all interactions.
3. **Use Proper Commit Messages**: Write clear, concise, and descriptive commit messages.
## Pull Requests (PRs)
1. **Fork Before Working**: Always fork the repository and work on your fork.
2. **Create a Feature Branch**: Do not work on the `main` branch. Create a separate branch for each feature or bug fix.
3. **Detailed PR Description**: Include a detailed explanation of the changes in your PR.
4. **Avoid Large Changes**: Submit small, focused PRs.
5. **Ensure Code Quality**: Follow coding standards and include comments where necessary.
## Issues
1. **Search Before Raising**: Check if the issue already exists to avoid duplicates.
2. **Provide Details**: Clearly describe the problem and include steps to reproduce it, if applicable.
3. **Be Constructive**: Avoid vague or unhelpful comments on issues.
## Testing
1. **Test Your Code**: Ensure that your changes are well-tested before submission.
2. **No Breaking Changes**: Make sure your contribution doesn’t break existing functionality.
## Licensing
1. **Follow Licensing Rules**: By contributing, you agree that your work will be licensed under this repository’s license.
## Acknowledgment
We appreciate your contributions and look forward to collaborating!
Contact us through email : [email protected]