JavaAlgorithms/CONTRIBUTING.md

31 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

## How to contribute?
NOTE: *We DO NOT add leetcode problems. They are just applications of basic principles that can be found in other algorithms included in the repository.*
2023-01-04 16:13:38 +08:00
### Did you find a bug?
2023-01-04 16:13:38 +08:00
**Ensure the bug was not already reported** by searching on GitHub under [Project Issues](https://github.com/TheAlgorithms/Java/issues).
- If it is mentioned in the issues and you want to fix it, [fork](https://github.com/TheAlgorithms/Java/fork) the repository and submit your implementation in a pull request. The project maintainers will evaluate it.
- If the bug is **NOT** mentioned in the issues, [open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title**, a clear **description** and a **test case** demonstrating the expected behavior that is not occurring.
2023-01-04 16:13:38 +08:00
NOTE: *Please avoid opening issues asking to be "assigned" to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request and project maintainers will evaluate it.*
2023-01-04 16:13:38 +08:00
### Do you want to contribute to the documentation?
- [Fork](https://github.com/TheAlgorithms/Java/fork) the repository and make necessary changes.
- Create a pull request.
- It will be put under review for approval.
- If approved, the requested changes will be merged to the repository.
2023-01-04 16:13:38 +08:00
### Do you want to add a new feature?
2020-10-23 14:07:43 +08:00
2023-01-04 16:13:38 +08:00
- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new).
- Be sure to include a **title**, a clear **description** and a **test case** demonstrating the new feature you want to add to the project.
2020-10-23 14:07:43 +08:00
2023-01-04 16:13:38 +08:00
### Do you have questions about the source code?
2021-10-13 00:25:21 +08:00
- Ask any question about how to use the repository in the [TheAlgorithms room in GITTER](https://gitter.im/TheAlgorithms/community?source=orgpage#) or [open a new issue](https://github.com/TheAlgorithms/Java/issues/new)
:+1::tada: That's all you need to know about the process now it's your turn to help us improve the repository, thank you again! :+1::tada: