Added special github contributing text

master
Karl F 2016-08-15 20:50:29 +02:00
parent ea6dd475ff
commit 8e6656cb18
1 changed files with 32 additions and 0 deletions

32
.github/contributing.md vendored Normal file
View File

@ -0,0 +1,32 @@
# Contributing
Contributions are welcome!
The following text assumes you're about to submit a new pull request.
For _how_ to contribute, please see [wiki](http://pioneerwiki.com/wiki/How_you_can_contribute).
### Check before submitting
- Have you read [code style](http://pioneerwiki.com/wiki/Code_style) on the wiki?
- If new to github, make sure you're not opening this pull request from your _master_ branch, but rather a new [separate branch](http://pioneerwiki.com/wiki/Using_git_and_GitHub#Making_a_pull_request)
- Have you reviewed your code? Don't trust the developers to do it, as they don't have time to read your code.
- Do you foresee any potential pitfalls or issues? If so please mention them.
- If a new feature, then please describe it, possibly with screenshot if something graphical.
- If a bug fix, then please use [key phrases](https://help.github.com/articles/closing-issues-via-commit-messages/) so that the original issue will be auto-closed upon merge. E.g.:
```
fix #1234
fixes #1234
close #1234
closes #1234
resolve #1234
resolves #1234
```
### Consider after submitting
After a pull request has been submitted, it is more common than not, that the branch keeps being modified, as bugs or issues are raised. If the change is to the latest commit on the branch, use `git add`, followed by `git commit --amend`, followed by a forced push, `git push -f`, to keep commit history clean. See [wiki](http://pioneerwiki.com/wiki/Using_git_and_GitHub) for details on editing/fixing commits.
If you're hungry to contribute more, you'll find some pointers on [How you can contribute](http://pioneerwiki.com/wiki/How_you_can_contribute).
Thanks for your contribution!