lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-03-28 21:16:20 +01:00
Code Activity

docs overhaul: move git cli instructions to a separate file

Browse source
This commit is contained in:
Waldir Pimenta 2017-11-27 18:43:52 +00:00 • committed by Agniva De Sarker
parent f8c7dfc0c7
commit e2ab1818f1
2 changed files with 26 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTING.md
View file

@ -72,38 +72,12 @@ refer to the [style guide](./STYLEGUIDE.md).
## 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.
Check out the step-by-step instructions (with screenshots) on
[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 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.
Alternatively, you can do most of the process
[using git on the command line](contributing-guides/git-terminal.md).
### Commit message

24
contributing-guides/git-terminal.md Normal file
View 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.