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:
-
Fork the tldr-pages/tldr repository on the GitHub web interface.
-
Clone your fork locally:
git clone https://github.com/{{your_username}}/tldr.git && cd tldr -
Create a feature branch, e.g. named after the command you plan to edit:
git checkout -b {{branch_name}} -
Make your changes (edit existing files or create new ones)
-
Commit the changes (following the commit message guidelines):
git commit --all -m "{{commit_message}}" -
Push the commit(s) to your fork:
git push origin {{branch_name}} -
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.)