Skip to content

Commit 0893c2f

Browse files
connectwithsantoshsumanashrestha
authored andcommitted
Added Contribution Guidelines.
1 parent 1703733 commit 0893c2f

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTION.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Contributing Guidelines
2+
3+
Thank you for considering contributing to our project! We welcome contributions from everyone. To maintain a positive and collaborative environment, please follow these guidelines:
4+
5+
### Creating Issues:
6+
7+
1. **Search Existing Issues**: Before creating a new issue, please search existing issues to see if the topic has already been discussed or reported.
8+
9+
2. **Clear and Descriptive Title**: Provide a clear and descriptive title for your issue, summarizing the problem or enhancement.
10+
11+
3. **Detailed Description**: Provide a detailed description of the issue, including steps to reproduce (if applicable), expected behavior, and actual behavior.
12+
13+
4. **Use Labels**: Use appropriate labels to categorize your issue (e.g., bug, enhancement, documentation, etc.).
14+
15+
### Pull Requests (PRs):
16+
17+
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
18+
19+
2. **Clone the Repository**: Clone the forked repository to your local machine using the `git clone` command.
20+
21+
3. **Create a Branch**: Create a new branch for your contribution. Use descriptive and concise names for your branches. Avoid using special characters and whitespace.
22+
23+
4. **Make Changes**: Make your desired changes to the codebase.
24+
25+
5. **Code Style:** Follow the existing code style and conventions. Ensure proper indentation, variable naming, and commenting.
26+
27+
5. **Test Your Changes**: Ensure that your changes do not break existing functionality. Write test cases to cover your code changes. Ensure that existing tests pass successfully.
28+
29+
6. **Commit Your Changes**: Commit your changes. Write clear and meaningful commit messages. Include a brief summary in the first line followed by a more detailed description if necessary.
30+
31+
7. **Push Changes**: Push your changes to your forked repository.
32+
33+
8. **Submit a Pull Request (PR)**: Once you have pushed your changes, submit a pull request to the main repository. Use a descriptive title for your pull request that summarizes the changes made.
34+
35+
9. **Review Process**: Your PR will be reviewed by project maintainers. Please be patient during the review process and be open to feedback and suggestions.
36+
37+
10. **Merge PR**: If your PR is approved, it will be merged into the main repository. Congratulations on your contribution!
38+
39+
11. **Stay Engaged**: Stay engaged with the community, participate in discussions, and consider contributing further.
40+
41+
Thank you for your interest in contributing to our project! Your contributions help make this project better for everyone.

0 commit comments

Comments
 (0)