From ae43e5ce190bf7e9f2db8a57a85a850336c8e88a Mon Sep 17 00:00:00 2001 From: M M Arif Date: Mon, 21 Feb 2022 13:19:04 +0100 Subject: [PATCH] Add 'Contributing' --- Contributing.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..c63c72c --- /dev/null +++ b/Contributing.md @@ -0,0 +1,36 @@ +# Contributing to GitNex + +Please take a few minutes to read this document to make the process of contribution more easy and healthy for all involved. + +### General +> **Be polite and gentle while commenting or creating new issues to maintain a healthy environment in which __everyone__ is able to feel comfortable.** +
+ +### Issues and Reports +Before creating an issue please take a moment and search the repository issues(open/closed) to avoid duplicate issues either it's a bug or feature. +In case you want to submit a bug report, please provide as much details as possible to better debug the problem. The important part is how to reproduce the bug and steps to reproduce are appreciated.

+**Note:** Please contact the project directly via [email](mailto:hello@gitnex.com) if have to share sensitive and security related details. +
+ +### Pull Requests +Patches, enhancements and features are always welcome. +The PR should focus on the scope of work and avoid many unnecessary commits. +Please provide as much detail and context as possible to explain the work submitted. + +**Please ask if you are not sure about the scope of work to be submitted to avoid waste of time spent on the work.** (Submit an issue, __before__ submitting a PR) + +**Code Standards**

+Please follow the code standards, this will help other developers to understand your code too. +It also helps maintaining the code afterwards. +It is documented in the Wiki: [Code-Standards](https://codeberg.org/gitnex/GitNex/wiki/Code-Standards) + +**How to submit a PR (Pull Request)** +1. Fork this repository. +2. Clone the forked repository from your namespace to your local machine. +3. Create a new branch and work on your feature, enhancement or patch. +4. Push your commits to your forked version. +5. You can now create a PR using the web interface against **main** branch. + +For more information, click [here](http://makeapullrequest.com/). + +**IMPORTANT:** By submitting PR, you agree to allow GitNex to license your work under the same license as that used by GitNex. \ No newline at end of file