Git
/
cheat
mirror of https://github.com/cheat/cheat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md 

Put some useful information in `CONTRIBUTING.md`.
This commit is contained in:
Chris Lane 2017-02-28 17:45:53 -05:00
parent 8019325f1e
commit b9241efab1
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -3,15 +3,23 @@ Contributing
If you would like to contribute cheetsheets or program functionality, please
fork this repository, make your changes, and submit a pull request.
## Python standards ##
Python code should conform to [PEP 8][].
Licensing
---------
By contributing to the project, you agree to license your work under the same
licenses as `cheat` itself. `cheat` is currently dual-licensed under the GPL3
and MIT licenses, though that could change without notice in the future.
`cheat`, however, will always remain free software (as in both "free as in
freedom" and "free as in beer") and shall always be licensed accordingly.
## Cheatsheet Format ##
Please pattern your cheatsheets after the following:
```sh
# To extract an uncompressed archive:
tar -xvf /path/to/foo.tar
# To create an uncompressed archive:
tar -cvf /path/to/foo.tar /path/to/foo/
# To extract a .gz archive:
tar -xzvf /path/to/foo.tgz
```
[PEP 8]: http://legacy.python.org/dev/peps/pep-0008/