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.

CONTRIBUTING.md 1.6 KiB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. # Contributing
  2. > _A real community, however, exists only when its members interact in a meaningful way that deepens their understanding of each other and leads to learning._
  3. If you would like to support this project, have an interesting idea how to improve the operation of this tool, or if you found some errors - fork this, add your fixes, and add a pull request of your branch to the **master branch**.
  4. ## Signature of commit
  5. 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` :
  6. ```
  7. SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
  8. grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
  9. ```
  10. ## Pull requests
  11. When creating a pull request, please heed the following:
  12. - Base your code on the latest master branch to avoid manual merges
  13. - Code review may ensue in order to help shape your proposal
  14. - Explain the problem and your proposed solution
  15. - One-line description - please don't continue the description on new lines
  16. ## How to find broken links?
  17. ```bash
  18. git clone https://github.com/trimstray/the-book-of-secret-knowledge && cd the-book-of-secret-knowledge
  19. for i in $(sed -n 's/.*href="\([^"]*\).*/\1/p' README.md | grep -v "^#") ; do
  20. _rcode=$(curl -s -o /dev/null -w "%{http_code}" "$i")
  21. if [[ "$_rcode" != "2"* ]] ; then echo " -> $i - $_rcode" ; fi
  22. done
  23. ```
  24. Result:
  25. ```bash
  26. -> https://ghostproject.fr/ - 503
  27. -> http://www.mmnt.net/ - 302
  28. -> https://search.weleakinfo.com/ - 503
  29. [...]
  30. ```