From e2ab1818f1cff9f04c53b3d9e7b62c1e88553adb Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Mon, 27 Nov 2017 18:43:52 +0000 Subject: [PATCH] docs overhaul: move git cli instructions to a separate file --- CONTRIBUTING.md | 30 ++--------------------------- contributing-guides/git-terminal.md | 24 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 28 deletions(-) create mode 100644 contributing-guides/git-terminal.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fbc4494b0..7b51644d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/contributing-guides/git-terminal.md b/contributing-guides/git-terminal.md new file mode 100644 index 000000000..6120e3a16 --- /dev/null +++ b/contributing-guides/git-terminal.md @@ -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. \ No newline at end of file