Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

96 lines (61 loc) · 2.39 KB
Raw

Git-CheatSheet

Your all in one Git, Github and Terminal Cheatsheet.. Feel free to contribute and commit and raise PR

Contributions Needed:

  • Adding more Features to the Website.

  • Contributing to current Open Issues.

  • Resolving Website Bugs.

  • Adding Important yet Missed out Commands.

  • Other Contributions, Issues, Enhancements are welcomed as well.

How to contribute?

STEP 1 : Fork this repository.

STEP 2 : Clone your forked copy of the project.

git clone https://github.com/<your_username>/Git-CheatSheet.git

STEP 3 : Navigate to the project directory .

cd Git-CheatSheet

STEP 4 : Add a reference (remote) to the original repository.

git remote add upstream https://github.com/EshanTrivedi21/Git-CheatSheet.git

STEP 5 : Check the remotes for this repository.

git remote -v

STEP 6 : Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream master

STEP 7 : Create a new branch.

git checkout -b <your_branch_name>

STEP 8 : Perform your desired changes to the code base.

STEP 9 : Track your changes .

git add .

STEP 10 : Commit your changes .

git commit -m "Relevant message"

STEP 11 : Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

STEP 12 : To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

STEP 13 : Add appropriate title and description to your pull request explaining your changes and efforts done.

STEP 14 : Click on Create Pull Request.

Voila! You have made a PR to the Git-CheatSheet. Sit back patiently and relax while your PR is reviewed

Points to remember:

  • Anyone who is sending a Pull Request make sure that you Refactor your code.

  • Properly Organize the things that you add or delete and mention them in you commits description

  • We will carry out this task after every Major Update has been done

  • But just stating this here so that people from now on make sure to properly organize those big chunks of codes.

Thank You.