1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-03-28 21:16:20 +01:00
tldr/contributing-guides/git-terminal.md
bl-ue 8ebd171d6f
*: fix typos reported by Hunspell (#5848)
Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
Co-authored-by: Seth Falco <seth@falco.fun>
Co-authored-by: Patrice Denis <patricedenis@users.noreply.github.com>
2021-05-20 16:13:41 -04:00

1.2 KiB

Most people submit pull requests to the tldr-pages project using GitHub's web interface.

If you prefer, you can do most of the process using the command-line instead. The overall process should look somewhat like this:

  1. Fork the tldr-pages/tldr repository on the GitHub web interface.

  2. Clone your fork locally: git clone https://github.com/{{your_username}}/tldr.git && cd tldr

  3. Create a feature branch, e.g. named after the command you plan to edit: git checkout -b {{branch_name}}

  4. Make your changes (edit existing files or create new ones)

  5. Commit the changes (following the commit message guidelines): git commit --all -m "{{commit_message}}"

  6. Push the commit(s) to your fork: git push origin {{branch_name}}

  7. Go to the GitHub page for your fork and click the green "pull request" button.

Please only send related changes in the same pull request. Typically a pull request will include changes in a single file. (Exceptions are occasionally acceptable.)