From 30c8d98ee9b9f62fa0dffde822aa8c12a122afb4 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Mon, 27 Nov 2017 19:03:11 +0000 Subject: [PATCH] docs overhaul: expand git-terminal.md a bit --- contributing-guides/git-terminal.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/contributing-guides/git-terminal.md b/contributing-guides/git-terminal.md index 6120e3a16..416e2f1f7 100644 --- a/contributing-guides/git-terminal.md +++ b/contributing-guides/git-terminal.md @@ -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. \ No newline at end of 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" \ No newline at end of file