ch0ic3/the-book-of-secret-knowledge
1
0
Fork 0
mirror of https://github.com/trimstray/the-book-of-secret-knowledge.git synced 2024-12-19 01:46:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated CONTRIBUTING.md

Browse Source 
- signed-off-by: trimstray <trimstray@gmail.com>
This commit is contained in:
trimstray 2018-11-12 19:18:32 +01:00
parent 5dddd67cf2
commit 93c1ad68e0
1 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -2,23 +2,6 @@
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 **testing branch**. 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 **testing branch**.
## Bash style
I would like you to stick to certain standards of writing in bash. I realize that it is not easy and time-consuming if you have certain habits. I do not expect 100% compliance and adherence to good practices, however, I would like you to try to use certain principles.
The following should help:
- [http://wiki.bash-hackers.org/](http://wiki.bash-hackers.org/)
- [https://google.github.io/styleguide/shell.xml](https://google.github.io/styleguide/shell.xml)
- [https://github.com/progrium/bashstyle](https://github.com/progrium/bashstyle)
- [http://kvz.io/blog/2013/11/21/bash-best-practices/](http://kvz.io/blog/2013/11/21/bash-best-practices/)
## Shellcheck
One of the requirements before approving your changes is to check them with the **shellcheck** utility. If the returned errors are not critical (eg. [SC2154](https://github.com/koalaman/shellcheck/wiki/SC2154)) you can use the `shellcheck disable=SC2154` design.
## Signature of commit ## 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` : 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` :
@ -32,6 +15,6 @@ grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
When creating pull request, please heed the following: When creating pull request, please heed the following:
- Base your code on the latest **testing branch** - Base your code on the latest master branch to avoid manual merges
- Code review may ensue in order to help shape your proposal - Code review may ensue in order to help shape your proposal
- Explain the problem and your proposed solution - Explain the problem and your proposed solution