From 4a9bde8731cd9ce842ba726f7348a1d95043ab05 Mon Sep 17 00:00:00 2001 From: opyale Date: Thu, 29 Oct 2020 17:24:19 +0100 Subject: [PATCH] Improving templates. (#746) Additional improvements. Merge branch 'master' into improving-templates Improving templates. Reviewed-on: https://codeberg.org/gitnex/GitNex/pulls/746 Reviewed-by: M M Arif --- .gitea/issue_template.md | 30 ++++++++++++++----------- .gitea/pull_request_template.md | 13 ++++++----- CONTRIBUTING.md | 39 ++++++++++++++++++++------------- 3 files changed, 48 insertions(+), 34 deletions(-) diff --git a/.gitea/issue_template.md b/.gitea/issue_template.md index 45055cad..d1307a05 100644 --- a/.gitea/issue_template.md +++ b/.gitea/issue_template.md @@ -1,33 +1,37 @@ ## # What do you want to address? -(This step is required; examples are shown below) + - [ ] Bug - [ ] Feature - [ ] Suggestion ## # Describe your matter briefly -(This step is required) + +

- -##### What did you expect? (Useful when addressing bugs) +##### What did you expect? --- -_(This step is optional)_ + +

- -##### Some additional details (Useful, when we are trying to reproduce a bug) +##### Some additional details --- -_(This step is optional; an example is shown below)_ + * The version of **Gitea** you are using: * The version of **GitNex** you are using: -* Source of installation(Google play, F-droid, APK): -* Phone **OS** version and model: -* The type of certificate you are using (self-signed, signed): +* Source of installation (Play Store, F-Droid, APK): +* Current android version and phone model/manufacturer: +* The type of certificate your instance is using (self-signed, signed): * How you used to log in (via password or token): - +
##### We would appreciate some screenshots or stacktrace's, but this is also not required. --- -_(Screenshots and stacktrace's can go here)_ + +

+ +- [ ] I carefully read the [contribution guidelines](https://codeberg.org/GitNex/GitNex/src/branch/master/CONTRIBUTING.md). +
#### Thank you for your time. \ No newline at end of file diff --git a/.gitea/pull_request_template.md b/.gitea/pull_request_template.md index d5a4d998..dd43dcc3 100644 --- a/.gitea/pull_request_template.md +++ b/.gitea/pull_request_template.md @@ -1,8 +1,9 @@ -Please check the following: +### Describe what your pull request does and which issue you’re targeting + +

-1. Make sure you are targeting the `master` branch, pull requests on release branches are only allowed for bug fixes. -2. Read contributing guidelines: [CONTRIBUTING.md](https://gitea.com/GitNex/GitNex/src/branch/master/CONTRIBUTING.md) -3. Please follow the [Code-Standards](https://gitea.com/gitnex/GitNex/wiki/Code-Standards) -4. Describe what your pull request does and which issue you’re targeting (create one if does not exist) + -**You MUST delete the content above including this line before posting, otherwise your pull request will be invalid.** +- [ ] I carefully read the [contribution guidelines](https://codeberg.org/GitNex/GitNex/src/branch/master/CONTRIBUTING.md). +- [ ] I'm following the code standards as defined [here](https://codeberg.org/gitnex/GitNex/wiki/Code-Standards). +- [ ] By submitting this pull request, I permit GitNex to license my work under the [GNU General Public License v3](https://codeberg.org/GitNex/GitNex/src/branch/master/LICENSE). \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a98f6ed1..43385f65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,26 +2,35 @@ Please take a few minutes to read this document to make the process of contribution more easy and healthy for all involved. -## Pull Requests -Patches, enhancements, 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. +### General +> **Be polite and gentle while commenting or creating new issues to maintain a healthy environment in which __everyone__ is able to feel comfortable.** +
-Please ask if you are not sure about the scope of work to be submitted to avoid waste of time spent on the work. +### 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:gitnex@swatian.com) if have to share sensitive and security related details. +
-**Code Standards** +### 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** -Fork this repository. Pull the forked repository from your namespace to your local machine. Create new branch and work on the bug/feature/enhancement you would like to submit. Push it to your forked version. From there create Pull Request(PR) against **master** branch. +**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 **master** branch. -**IMPORTANT:** By submitting PR, you agree to allow GitNex to license your work under the same license as that used by GitNex. +For more information, click [here](http://makeapullrequest.com/). -## Issues and Reports -*1st of please be polite and gentle while commenting or creating new issue to maintain a healthy environment.* - -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(gitnex@swatian.com) if have to share sensitive and security related details. +**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