Browse Source

A collection of inspiring lists, manuals, cheatsheets, blogs, hacks, one-liners, cli/web tools and more.

pull/199/head
netredo 4 years ago
parent
commit
a83e849ece
4 changed files with 2211 additions and 324 deletions
  1. +7
    -21
      CONTRIBUTING.md
  2. +0
    -1
      LICENSE.md
  3. +2204
    -302
      README.md
  4. BIN
      static/img/the-book-of-secret-knowledge-preview.png

+ 7
- 21
CONTRIBUTING.md View File

@@ -1,37 +1,23 @@
# Contributing

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**.
> _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._

## 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.
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**.

## 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` :

``````
```
SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
``````
```

## Pull requests

When creating pull request, please heed the following:
When creating a 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
- Explain the problem and your proposed solution
- One-line description - please don't continue the description on new lines

+ 0
- 1
LICENSE.md View File

@@ -673,4 +673,3 @@ library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.


+ 2204
- 302
README.md
File diff suppressed because it is too large
View File


BIN
static/img/the-book-of-secret-knowledge-preview.png View File

Before After
Width: 797  |  Height: 377  |  Size: 39 KiB

Loading…
Cancel
Save