Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (57 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

89 lines (57 loc) · 2.04 KB

Git-CheatSheet

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

Contributions Needed:

  • Converting .txt to a .md markdown file.

  • Converting .md to a .adoc file.

  • Contributing to the Website.

  • Adding Important yet Missed out Commands.

  • Creating a PDF from the Text File

  • Adding a download button which download the PDF (Website)

  • Other Contributions are welcomed as well.

How to contribute?

1. Fork this repository.

2. Clone your forked copy of the project.

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

3. Navigate to the project directory 📁 .

cd Git-CheatSheet

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

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

5. Check the remotes for this repository.

git remote -v

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

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Commit your changes .

git commit -m "Relevant message"

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

git push -u origin <your_branch_name>

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.

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

14. Click on Create Pull Request.

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

Thank You.