the-book-of-secret-knowledge/CONTRIBUTING.md
trimstray 95dda7221b updated 'Pull requests' info
- signed-off-by: trimstray <trimstray@gmail.com>
2018-12-19 09:03:43 +01:00

982 B

Contributing

If you would like to support this project, you have an interesting idea how to improve the operation of this tool or if you found some errors - do fork this add your fixes and add pull-request of your branch to the master branch.

Signature of commit

Moving forward all commits to this project must include a "signed-off-by" line indicating the name and email address of the contributor signing off on the change. To enable signatures add the following lines to .git/hooks/prepare-commit-msg :

SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

Pull requests

When creating pull request, please heed the following:

  • Base your code on the latest master branch to avoid manual merges
  • Code review may ensue in order to help shape your proposal
  • Explain the problem and your proposed solution
  • One-line description - please don't continue the description on new lines