added 'Contributing' chapter

- signed-off-by: trimstray <trimstray@gmail.com>
This commit is contained in:
trimstray 2018-12-17 23:54:17 +01:00
parent f6dd68a424
commit 174547e1d1

View file

@ -34,20 +34,29 @@
*** ***
<p align="center">
» <b><code><a href="https://github.com/trimstray/the-book-of-secret-knowledge/issues">All suggestions are welcome</a></code></b> «
</p>
## :notebook_with_decorative_cover: &nbsp;What is it? ## :notebook_with_decorative_cover: &nbsp;What is it?
This list is a collection of various materials that I use every day in my work. It contain a lot of useful information gathered in one piece. This list is a collection of various materials that I use every day in my work. It contain a lot of useful information gathered in one piece.
> `This is not a final and full version - I update it on an ongoing basis.`
## :restroom: &nbsp;For whom? ## :restroom: &nbsp;For whom?
It is intended for everyone and anyone - especially for System and Network Administrators, DevOps, Pentesters or Security Researchers. It is intended for everyone and anyone - especially for System and Network Administrators, DevOps, Pentesters or Security Researchers.
## :information_source: &nbsp;Contributing
A few simple rules for this project:
- inviting and clear
- not tiring
- useful
These below rules may be better:
- easy to contribute to
- easy to find (no TOC)
Before add pull request please see **[this](https://github.com/trimstray/the-book-of-secret-knowledge/blob/master/CONTRIBUTING.md)**.
## :ballot_box_with_check: &nbsp;Todo ## :ballot_box_with_check: &nbsp;Todo
- [ ] Add useful shell functions - [ ] Add useful shell functions