mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-09-11 12:05:35 +03:00
docs overhaul: move git cli instructions to a separate file
This commit is contained in:
parent
f8c7dfc0c7
commit
e2ab1818f1
@ -72,38 +72,12 @@ refer to the [style guide](./STYLEGUIDE.md).
|
|||||||
|
|
||||||
## Submitting a pull request
|
## Submitting a pull request
|
||||||
|
|
||||||
For submitting changes, you can use whatever workflow you're more comfortable with.
|
|
||||||
|
|
||||||
### Using Github's web interface
|
|
||||||
|
|
||||||
The easiest way to submit a change is to just edit the page directly on the Github interface.
|
The easiest way to submit a change is to just edit the page directly on the Github interface.
|
||||||
Check out the step-by-step instructions (with screenshots) on
|
Check out the step-by-step instructions (with screenshots) on
|
||||||
[Github Help](https://help.github.com/articles/editing-files-in-another-user-s-repository/).
|
[Github Help](https://help.github.com/articles/editing-files-in-another-user-s-repository/).
|
||||||
|
|
||||||
### Using the command line
|
Alternatively, you can do most of the process
|
||||||
|
[using git on the command line](contributing-guides/git-terminal.md).
|
||||||
Alternatively, you can do most of the process using the command line:
|
|
||||||
|
|
||||||
- fork the 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 a new one)
|
|
||||||
|
|
||||||
- commit the changes:
|
|
||||||
`git commit --all -m "{{commit_message}}"`
|
|
||||||
|
|
||||||
- push to your fork:
|
|
||||||
`git push origin {{branch_name}}`
|
|
||||||
|
|
||||||
- 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.
|
|
||||||
|
|
||||||
### Commit message
|
### Commit message
|
||||||
|
|
||||||
|
24
contributing-guides/git-terminal.md
Normal file
24
contributing-guides/git-terminal.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
Most people submit pull requests to the tldr project using GitHub's web interface.
|
||||||
|
|
||||||
|
If you prefer, you can do most of the process using the command line instead:
|
||||||
|
|
||||||
|
- fork the 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 a new one)
|
||||||
|
|
||||||
|
- commit the changes:
|
||||||
|
`git commit --all -m "{{commit_message}}"`
|
||||||
|
|
||||||
|
- push to your fork:
|
||||||
|
`git push origin {{branch_name}}`
|
||||||
|
|
||||||
|
- 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.
|
Loading…
Reference in New Issue
Block a user