mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-03-28 21:16:20 +01:00
docs overhaul: expand git-terminal.md a bit
This commit is contained in:
parent
e2ab1818f1
commit
30c8d98ee9
1 changed files with 18 additions and 11 deletions
|
@ -1,24 +1,31 @@
|
|||
Most people submit pull requests to the tldr project using GitHub's web interface.
|
||||
Most people submit pull requests to the tldr project
|
||||
[using GitHub's web interface][pr-howto].
|
||||
|
||||
If you prefer, you can do most of the process using the command line instead:
|
||||
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 repository on the github web interface
|
||||
1. Fork the tldr repository on the github web interface.
|
||||
|
||||
- clone your fork locally:
|
||||
2. 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:
|
||||
3. 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 a new one)
|
||||
4. Make your changes (edit existing files or create new ones)
|
||||
|
||||
- commit the changes:
|
||||
5. Commit the changes (following the [commit message guidelines][commit-msg]):
|
||||
`git commit --all -m "{{commit_message}}"`
|
||||
|
||||
- push to your fork:
|
||||
6. 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.
|
||||
7. Go to the github page for your fork and click the green "pull request" button.
|
||||
|
||||
Please send only related changes in the same pull request.
|
||||
Typically a pull request will include changes in a single file.
|
||||
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
|
||||
[mass-changes]: https://github.com/tldr-pages/tldr/pulls?&q=is:pr+is:merged+label:"mass+changes"
|
Loading…
Add table
Reference in a new issue