Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

CONTRIBUTING.md 2.1 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. ## Using the issue tracker
  5. The [issue tracker](https://github.com/trimstray/the-book-of-secret-knowledge/issues) is
  6. the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:
  7. * Please **do not** use the issue tracker for personal support requests (use
  8. [Stack Overflow](https://stackoverflow.com) or IRC)
  9. * Please **do not** derail or troll issues. Keep the discussion on topic and
  10. respect the opinions of others
  11. ## Signature of commit
  12. 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` :
  13. ```
  14. SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
  15. grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
  16. ```
  17. ## Pull requests
  18. When creating a pull request, please heed the following:
  19. - Base your code on the latest master branch to avoid manual merges
  20. - Code review may ensue in order to help shape your proposal
  21. - Explain the problem and your proposed solution
  22. - One-line description - please don't continue the description on new lines
  23. ## How to find broken links?
  24. ```bash
  25. git clone https://github.com/trimstray/the-book-of-secret-knowledge && cd the-book-of-secret-knowledge
  26. for i in $(sed -n 's/.*href="\([^"]*\).*/\1/p' README.md | grep -v "^#") ; do
  27. _rcode=$(curl -s -o /dev/null -w "%{http_code}" "$i")
  28. if [[ "$_rcode" != "2"* ]] ; then echo " -> $i - $_rcode" ; fi
  29. done
  30. ```
  31. Result:
  32. ```bash
  33. -> https://ghostproject.fr/ - 503
  34. -> http://www.mmnt.net/ - 302
  35. -> https://search.weleakinfo.com/ - 503
  36. [...]
  37. ```