Skip to content

Commit 7a288a4

Browse files
authored
Update CONTRIBUTING.md
1 parent a281216 commit 7a288a4

File tree

1 file changed

+48
-10
lines changed

1 file changed

+48
-10
lines changed

CONTRIBUTING.md

+48-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,58 @@
11
# Contributing
22

3-
You can contribute in 3 ways: creating issues, opening pull requests, and reviewing pull requests.
4-
## Creating Issues
3+
Thanks for your interest in contributing! We appreciate your support, and we welcome contributions from the community.
54

6-
Feel free to create an issue if you encounter any problems, have any suggestions, or would like a specific new algorithm or language to be included. Open a new PR directly in cases of minor corrections or inclusion of algorithms already listed in a language not yet implemented.
5+
Before you start contributing, please take a moment to review this document to understand the process and guidelines for contributing to our project.
76

8-
Before creating the issue, check for similar issues and remember to detail the problem encountered or proposed suggestion.
7+
## Code of Conduct
98

10-
## Opening Pull Requests
9+
We have adopted a [Code of Conduct](./CODE-OF-CONDUCT.md) that we expect all community members to follow. Please make sure to review and adhere to it in all interactions within our community.
1110

12-
It is also possible to contribute by opening a Pull Request (PR) with a solution to a problem or including a new algorithm.
11+
## How Can I Contribute?
1312

14-
When opening a PR, remember to include a relevant description of the changes made and add a link in the project's README if new algorithms are incorporated.
13+
There are various ways to contribute:
1514

16-
## Reviewing Pull Requests
15+
- Reporting Issues: If you encounter a bug or have a feature request, please open an issue on GitHub.
16+
- Code Contributions: If you are a developer, you can help us by submitting pull requests.
17+
- Documentation: Improvements to our documentation are always welcome.
1718

18-
Another way to contribute to the project is by reviewing open PRs. If you have mastery of an algorithm, data structure, or even a specific programming language, feel free to help review the open PRs.
19+
## Reporting Issues
1920

20-
When reviewing, remember to be cordial/polite and, if possible, manually test the change or correction before approving the PR.
21+
If you encounter an issue or have a feature request, please follow these steps:
22+
23+
1. Check if the issue or feature request already exists.
24+
2. If it doesn't exist, please open a new issue, providing a clear and detailed description of the problem or request.
25+
3. Use a descriptive title, provide steps to reproduce the issue, and specify your environment.
26+
27+
## Development Guidelines
28+
29+
Before you start working on a contribution, please keep in mind the following guidelines:
30+
31+
- Adhere to our [Code of Conduct](./CODE-OF-CONDUCT.md).
32+
- Respect and follow existing project coding standards.
33+
- Write clear and concise commit messages.
34+
- Test your changes thoroughly.
35+
- Make your code clean and readable.
36+
- Document your code as necessary.
37+
38+
## Submitting Pull Requests
39+
40+
To submit a pull request, please follow these steps:
41+
42+
1. Fork the repository.
43+
2. Create a new branch for your contribution: `git checkout -b feature/my-contribution`.
44+
3. Make your changes and commit them.
45+
4. Ensure that your code is properly tested.
46+
5. Create a pull request against our main branch.
47+
6. Clearly describe your changes, why they are necessary, and how to test them.
48+
7. Be responsive to feedback and participate in the review process.
49+
50+
## Review Process
51+
52+
All contributions will be reviewed by project maintainers. We may provide feedback or request additional changes. Your contribution will be merged once it meets our standards.
53+
54+
## Getting Help
55+
56+
If you need assistance or have any questions, you can reach out to us. We are here to help you with your contributions.
57+
58+
We look forward to your contributions and thank you for your time and effort!

0 commit comments

Comments
 (0)