2017-11-27 19:03:11 +00:00
|
|
|
Most people submit pull requests to the tldr project
|
|
|
|
|
[using GitHub's web interface][pr-howto].
|
2017-11-27 18:43:52 +00:00
|
|
|
|
2017-11-27 19:03:11 +00:00
|
|
|
If you prefer, you can do most of the process using the command line instead.
|
|
|
|
|
The overall process should look somewhat like this:
|
2017-11-27 18:43:52 +00:00
|
|
|
|
2019-12-07 22:36:53 +00:00
|
|
|
1. Fork the tldr repository on the GitHub web interface.
|
2017-11-27 18:43:52 +00:00
|
|
|
|
2020-03-11 00:27:49 +00:00
|
|
|
2. Clone your fork locally:
|
2017-11-27 18:43:52 +00:00
|
|
|
`git clone https://github.com/{{your_username}}/tldr.git && cd tldr`
|
|
|
|
|
|
2020-03-11 00:27:49 +00:00
|
|
|
3. Create a feature branch, e.g. named after the command you plan to edit:
|
2017-11-27 18:43:52 +00:00
|
|
|
`git checkout -b {{branch_name}}`
|
|
|
|
|
|
2017-11-27 19:03:11 +00:00
|
|
|
4. Make your changes (edit existing files or create new ones)
|
2017-11-27 18:43:52 +00:00
|
|
|
|
2020-03-11 00:27:49 +00:00
|
|
|
5. Commit the changes (following the [commit message guidelines][commit-msg]):
|
2017-11-27 18:43:52 +00:00
|
|
|
`git commit --all -m "{{commit_message}}"`
|
|
|
|
|
|
2020-03-11 00:27:49 +00:00
|
|
|
6. Push the commit(s) to your fork:
|
2017-11-27 18:43:52 +00:00
|
|
|
`git push origin {{branch_name}}`
|
|
|
|
|
|
2019-12-07 22:36:53 +00:00
|
|
|
7. Go to the GitHub page for your fork and click the green "pull request" button.
|
2017-11-27 18:43:52 +00:00
|
|
|
|
2017-11-27 19:03:11 +00:00
|
|
|
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][mass-changes].)
|
|
|
|
|
|
|
|
|
|
[pr-howto]: ../CONTRIBUTING.md#submitting-a-pull-request
|
|
|
|
|
[commit-msg]: ../CONTRIBUTING.md#commit-message
|
2019-12-07 22:36:53 +00:00
|
|
|
[mass-changes]: https://github.com/tldr-pages/tldr/pulls?&q=is:pr+is:merged+label:"mass+changes"
|
