summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorHolger Jeromin <mailgithub@katur.de>2015-03-03 14:11:08 +0100
committerHolger Jeromin <mailgithub@katur.de>2015-03-03 14:11:08 +0100
commit043a7f5da485ced3af190aa47163b14a7b025509 (patch)
treea8b06172b24a1ebcb3a018c46dce743f3ce4c67c /CONTRIBUTING.md
parentc9e8af52c24b405c65fc9220a6c5c573574df672 (diff)
downloadantennapod-043a7f5da485ced3af190aa47163b14a7b025509.zip
Mentioning "Closing issues via commit messages"
Mentioning https://help.github.com/articles/closing-issues-via-commit-messages/
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 46d52a383..e8d57f8c7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,7 +29,7 @@ Submit a pull-request
- If you want to work on a feature that has been requested or fix a bug that has been reported on the "issues" page, add a comment to it so that other people know that you are working on it.
- Fork the repository
- Almost all changes of AntennaPod are done on the `develop` branch. If a new version of AntennaPod is released, the `develop` branch is merged into `master`. As a result, the `master` branch probably doesn't contain the latest changes when you are reading this. Please make sure that you are branching from `develop`! Otherwise, there might be a lot of merge-conflicts when merging your changes into `develop` and therefore it might take longer to review your pull-request. Exceptions are changes in files like README.md, CONTRIBUTING.md and other files that are not directly related to the source code.
-- If your pull-request fixes a bug that has been reported or implements a feature that has been requested in another issue, try to mention it so that it can be closed once your pull-request has been merged.
+- If your pull-request fixes a bug that has been reported or implements a feature that has been requested in another issue, try to mention it so that it can be closed once your pull-request has been merged. If you use [special keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) github will close the issues automatically when the changes lands at the master branch.
- Although not every part of AntennaPod's source code is fully documented yet, it would be very nice if you could add documentation to your changes if it is a larger pull-request.
- If possible, add unit tests for your pull-request and make sure that they pass. Information on how to add unit tests and run them can be found here: [TODO]