Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.89 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.89 KB
Raw

CheatSheets

This repo is small project that is a central place for the most common commands used for systems we may use in work/projects.

It can allow new starters to contribute to projects on Github and get used to Git tools and commands.

You don't really need any coding experience as this is more of a documentation project, so no stress. Please feel free to contribute anytime you can, its appreciated.

I am still learning about Github and Git myself and want to get involved more within the open source community, so please feel free to give any advice or recommendations via an issue request.

To add stuff to this repo it is best to fork this repo, git clone your fork of the repo, create a branch and make changes, push them to your fork and then open a PR.

High level Steps include:

  1. Fork the repo and git clone your fork
  2. Create your branch
  3. Make your changes and commit them with a quick message of what was added
  4. Push your changes and branch to your forked repo
  5. Open a PR so your changes can be reviewed and merged into the main project

The changes will be reviewed and if all is well, merged into master.

Tip: Remember to add the main project as upstream and do a git pull or fetch to keep your local fork up to date with the main project, before you commit and push any changes to your forked version ready for a PR.

Here is a handy guide with more detail for clarity

Please have a search (ctrl + f) to see if the categories/commands or options have already been added, please do not duplicate already added entries. If possible try to group similar bundles of commands with each other.

The structure should be as followed.

Category or sub category:

    # Quick explanation of command
    	Command

e.g

Linux:

    # List files and Directories.
    	ls
    		#Options include.
    			-l = List
    			-h = Human readable file/directory size
    			etc


    # List files in a list, shows file size in human readable format and shows hidden files.
    	ls -lha

Looking at the example above the category/sub category name ends in a colon, then the command description is indented 1 tab (8 Spaces) below. The command itself is then indented 2 tabs (16 Spaces), the options title if applicable is indented 3 tabs (24 Spaces) and the options themselves indented 4 tabs (32 Spaces).

This is how the layout should be for the listed commands etc., please follow the same structure throughout each cheat sheet.

Thank you and have fun 😉