From b9241efab11aab9fdd787c0fceefb53c0db59a6e Mon Sep 17 00:00:00 2001 From: Chris Lane Date: Tue, 28 Feb 2017 17:45:53 -0500 Subject: [PATCH] CONTRIBUTING.md Put some useful information in `CONTRIBUTING.md`. --- CONTRIBUTING.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee064de..a2d3f87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/