mirror of
https://github.com/cheat/cheat.git
synced 2024-11-16 08:58:28 +01:00
b9241efab1
Put some useful information in `CONTRIBUTING.md`.
25 lines
580 B
Markdown
25 lines
580 B
Markdown
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][].
|
|
|
|
|
|
## 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/
|