From d81f499db3bad55864a630eb41ea170ab8040dec Mon Sep 17 00:00:00 2001 From: Sreedev Kodichath Date: Wed, 11 Jan 2023 19:14:39 -0500 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a705b3e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## How to contribute to Deduplicator + +#### **Did you find a bug?** + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/sreedevk/deduplicator/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/sreedevk/deduplicator/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +* If possible, use the [bug report template](https://github.com/sreedevk/deduplicator/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) to create the issue. + +#### **Would you like to write a fix for the bug?** +* Assign the Issue to yourself (if unassigned) before you start working in order to avoid any conficts. +* Open a new GitHub pull request with the patch. +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number. + +#### **Did you fix whitespace, format code, or make a purely cosmetic patch?** + +Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Deduplicator will generally not be accepted/ + +#### **Do you intend to add a new feature or change an existing one?** + +* First open an issue with the sugggestion using the [feature request template](https://github.com/sreedevk/deduplicator/blob/main/.github/ISSUE_TEMPLATE/feature-request.md) +* Do not create a PR before one of the core contributors has conveyed acceptance for a feature request. + +#### **Do you have questions about the source code?** + +* If you have a question, raise an issue in the repository with a "question" label.