Skip to content

Commit

Permalink
Updated contribution guidelines and PR template for branching from Ma…
Browse files Browse the repository at this point in the history
…ster
  • Loading branch information
rabidllama committed Mar 16, 2020
1 parent dc8dadb commit c9aa915
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ We :heart: pull requests! We also aspire to make our commit history cleaner and
We'd like all pull requests to adhere to the following rules:

- a PR has to **close an issue**. If there is none yet for yours, please [create one](https://github.com/GIScience/openrouteservice/issues/new)
- branch off [development](https://github.com/GIScience/openrouteservice/tree/development)
- branch off [master](https://github.com/GIScience/openrouteservice/tree/master)
- name your branch according to `<[hotfix/bugfix/feat/algo]>/<issue#>-<purpose>`, e.g. `[feat]/#381-simplify_geometry`
- if you introduce new functions/classes, write unit or API tests
- **limit the number of commits to a minimum**, i.e. use [`git commit --amend [--no-edit]`](https://www.atlassian.com/git/tutorials/rewriting-history#git-commit--amend)
Expand All @@ -73,7 +73,7 @@ git stash pop

Be extra careful using `rebase` commands when collaborating on a branch with other people.

**Don't merge** `development` branch into your feature branch.
**Don't merge** `master` branch into your feature branch.

### Contributing code

Expand Down
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Pull Request Checklist
<!--- Please make sure you have completed the following items BEFORE submitting a pull request (put an x in each box when you have checked you have done them): -->
- [ ] 1. I have [**rebased**](https://github.com/GIScience/openrouteservice/blob/master/CONTRIBUTE.md#pull-request-guidelines) the latest version of the development branch into my feature branch and all conflicts have been resolved.
- [ ] 1. I have [**rebased**](https://github.com/GIScience/openrouteservice/blob/master/CONTRIBUTE.md#pull-request-guidelines) the latest version of the master branch into my feature branch and all conflicts have been resolved.
- [ ] 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the [Unreleased] heading.
- [ ] 3. I have documented my code using JDocs tags.
- [ ] 4. I have removed unnecessary commented out code, imports and System.out.println statements.
Expand Down

0 comments on commit c9aa915

Please sign in to comment.