From 9d86348cce26bc3ad8643cddb00d614085e8d230 Mon Sep 17 00:00:00 2001 From: Abinash Satapathy Date: Wed, 4 Jan 2023 09:13:38 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#3486) --- CONTRIBUTING.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31e0a7e7..23ee1bb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,28 @@ ## How to contribute? -#### **Did you find a bug?** +### Did you find a bug? -- **Ensure the bug was not already reported** by searching on GitHub under [Project Issues](https://github.com/TheAlgorithms/Java/issues). +**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. -- 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. +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.* -- If you are unable to find an open issue referring to the same problem, depending on the type of issue follow the appropriate steps: -#### **Do you want to contribute to the documentation?** -- Please read the documentation here [Contributing to the Documentation](https://github.com/TheAlgorithms/Java/blob/master/CONTRIBUTING.md), [open a new issue](https://github.com/TheAlgorithms/Java/issues/new), make changes, and then create a pull request, it will be put under review and accepted if it is appropriate. +### 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. -#### **Do you want to add a new feature?** +### Do you want to add a new feature? -- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title, clear description** and **test case** demonstrating the new feature you want to add to the project. +- [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. -#### **Do you want to fix a bug?** -- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title and a clear description** and a **test case** demonstrating the expected behavior that is not occurring. - -#### **Do you have questions about the source code?** +### Do you have questions about the source code? - 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)