From 28f34e941407ad20c92828fecfac26be76d7bb60 Mon Sep 17 00:00:00 2001 From: Manfred Brandl Date: Tue, 21 Aug 2018 12:01:38 +0200 Subject: [PATCH] improve wording and structure --- CONTRIBUTING.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b622fa7ae..e882ce581 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -377,7 +377,7 @@ The `iD.js` and `iD.min.js` files in this project are autogenerated - don't edit If you are new to GitHub or git you can read the [GitHub Guides](https://guides.github.com) "Understanding the GitHub Flow", "Git Handbook" and "Forking Projects" could be especially interesting to you. -# Step by Step +### Step by Step Additionally here is a step-by-step workflow example for beginners: @@ -387,7 +387,7 @@ Additionally here is a step-by-step workflow example for beginners: 3. Set up [Git](https://help.github.com/articles/set-up-git/) and prepare for Authenticating with GitHub from Git. -4. Clone or download your local copy of iD from your GitHub account using https `git clone https://github.com:/iD.git` or using ssh `git clone git@github.com:/iD.git`. In your local copy you'll have a "remote" called origin. +4. Clone or download your local copy of iD from your GitHub account using https `git clone https://github.com:/iD.git` or using ssh `git clone git@github.com:{{yourgithubaccount}}/iD.git`. In your local copy you'll have a "remote" called origin. 5. Switch to the iD directory, create a working branch (choose a descriptive name) and switch to it : `cd iD ; git checkout -b `. Never do anything in master branch. @@ -397,18 +397,18 @@ Additionally here is a step-by-step workflow example for beginners: 8. Push Changes to your GitHub account `git push origin `. The next push also works without the branch name: `git push origin`. -9. Go to GitHub for your fork of iD at https://github.com//iD. GitHub will already know about your recently pushed branch, and ask if you want to create a Pull Request for it. +9. Go to GitHub for your fork of iD at https://github.com/{{yourgithubaccount}}/iD. GitHub will already know about your recently pushed branch, and ask if you want to create a Pull Request for it. 10. Your Pull Request will be seen by the maintainers of iD. They can merge it or ask for changes. You can update your Pull Request with Steps 7 and 8, Step 9 is required only once per Pull Request. -# Clean Up +### Clean Up After your Pull Request gets merged into the main repository you can clean up by deleting the branch from your GitHub-iD-Clone and your local directory `git push --delete origin ; git branch -d ` -# Restart with another PR after some while +### Restart with another PR after some while If you did not use your copy of iD for some while, other Pull Request gets merged and you don't have the latest version of iD. You can replace your master with whatever is in our master. If you have not done so yet: Add the main repo as an "upstream" remote: @@ -422,11 +422,10 @@ Then change to the master branch and get everything from upstream (the main repo ## Submitting directly in the Browser If you want to submit Documentation, Spelling improvements, etc. which do not need testing, -you can do this with your browser in GitHub. You also need a GitHub account and this [Article about Editing](https://help.github.com/articles/editing-files-in-another-user-s-repository/). -You might also finde this [about Pull Requests](https://help.github.com/articles/about-pull-requests/) usefull. -Please don't use this to change Code and create untested Pull Requests. +you can do this with your browser in GitHub. Please don't use this to change Code and create untested Pull Requests. +You also need a GitHub account and may find this [Article about Editing](https://help.github.com/articles/editing-files-in-another-user-s-repository/) and this [Article about Pull Requests](https://help.github.com/articles/about-pull-requests/) usefull. -# Step by Step with Browser +### Step by Step with Browser Additionally here is a step-by-step workflow example for beginners: @@ -434,12 +433,12 @@ Additionally here is a step-by-step workflow example for beginners: 2. Go to the [iD main repository](https://github.com/openstreetmap/iD) and fork iD into your GitHub account (Fork is top right). -3. Create a New Branch by clicking on "Branch: master" and entering the name of a new branch (choose a descriptive name) +3. Create a New Branch by clicking on "Branch: master" and entering the name of a new branch (choose a descriptive name). -4. Navigate to the file you want to edit and click on "Edit this file" and apply your changes to the file. Alternatively, you could also "Create a new file" +4. Navigate to the file you want to edit and click on "Edit this file" and apply your changes to the file. Alternatively, you could also "Create a new file". -5. When finished editing the file enter a commit text (and description if there is more to describe), commit directly to the newly created branch. +5. When finished editing the file enter a commit text (the description is optional) and commit directly to the newly created branch. You may repeat 4 and 5 until all required changes are commited. -6. Navigate back to your "id" project - https://github.com/{{user}}/iD +6. Navigate back to your "id" project - https://github.com/{{yourgithubaccount}}/iD -7. Follow https://help.github.com/articles/about-pull-requests/ to create a new pull request for your change +7. Follow this [Article about Pull Requests](https://help.github.com/articles/about-pull-requests/) to create a new pull request for your change