forked from tldr-pages/tldr
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs overhaul: expand git-terminal.md a bit
- Loading branch information
1 parent
e2ab181
commit 30c8d98
Showing
1 changed file
with
18 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" |