You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long. 1.8 KiB

  1. # Contributing
  2. 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**.
  3. ## Bash style
  4. 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.
  5. The following should help:
  6. - [](
  7. - [](
  8. - [](
  9. - [](
  10. ## Shellcheck
  11. 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]( you can use the `shellcheck disable=SC2154` design.
  12. ## Signature of commit
  13. 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` :
  14. ``````
  15. SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
  16. grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
  17. ``````
  18. ## Pull requests
  19. When creating pull request, please heed the following:
  20. - Base your code on the latest master branch to avoid manual merges
  21. - Code review may ensue in order to help shape your proposal
  22. - Explain the problem and your proposed solution