CalvinBackup/iD
1
0
Fork 0
mirror of https://github.com/FoggedLens/iD.git synced 2026-06-05 22:46:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5242 from manfredbrandl/patch-1

Browse Source 
Explain submitting Pull Request with Browser
This commit is contained in:
Bryan Housel
2018-08-21 09:20:25 -04:00
committed by GitHub
parent fa99665318 28f34e9414
commit e3c9697abd
1 changed files with 38 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+38 -6
View File
@@ -62,7 +62,7 @@ Issues that have a big impact or matter most to _new mappers_.
[priority_link]: https://github.com/openstreetmap/iD/issues?q=is%3Aopen+is%3Aissue+label%3Apriority
Red labels are for **bugs**. These are things that we want fixed, but might be a bit more
complicted than the green action items.
complicated than the green action items.
* <sub>[![bug][bug]][bug_link]
[![bug-release-blocker][bug-release-blocker]][bug-release-blocker_link]
@@ -182,6 +182,7 @@ Work in Progress. Don't start work on these, somebody else already did!
[bluesky_link]: https://github.com/openstreetmap/iD/issues?q=is%3Aopen+is%3Aissue+label%3Abluesky
[wip_link]: https://github.com/openstreetmap/iD/issues?q=is%3Aopen+is%3Aissue+label%3Awip
## Verifying Bug Fixes
To verify a bug fix (or test a new feature), use the [master deployment](http://preview.ideditor.com/master/)
@@ -191,6 +192,7 @@ latest code and translation strings.
The deployments on openstreetmap.org and http://preview.ideditor.com/release/ are updated only
with stable releases. Issues that are marked fixed in the tracker may still be present.
## Translating
Translations are managed using the
@@ -243,6 +245,7 @@ These are separate translations for uniformity reasons and because some language
may translate "type" differently in "type of aeroway" and "type of amenity", for
example.
## Adding New Strings for Translation or Updating Existing Strings
iD translates strings with a `t` function - `t('foo.bar')` translate the key
@@ -334,6 +337,7 @@ Test your code and make sure it passes.
2. run `npm install`
3. run `npm test` to see whether your tests pass or fail.
## Building / Installing
You can rebuild iD completely with the command `npm run all`.
@@ -367,12 +371,13 @@ The `iD.js` and `iD.min.js` files in this project are autogenerated - don't edit
3. Commit your changes with an informative commit message
4. [Submit a pull request](https://help.github.com/articles/using-pull-requests) to the `openstreetmap/iD` project.
## Using GitHub and git
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:
@@ -382,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:<yourgithubaccount>/iD.git` or using ssh `git clone git@github.com:<yourgithubaccount>/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:<yourgithubaccount>/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 <working-branch-name>`. Never do anything in master branch.
@@ -392,21 +397,48 @@ Additionally here is a step-by-step workflow example for beginners:
8. Push Changes to your GitHub account `git push origin <working-branch-name>`. 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/<yourgithubaccount/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 <working-branch-name> ; git branch -d <working-branch-name>`
## 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:
`git remote add upstream git@github.com:openstreetmap/iD.git`
Then change to the master branch and get everything from upstream (the main repository)
`git checkout master ; git fetch --all && git reset --hard upstream/master`
## 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. 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
Additionally here is a step-by-step workflow example for beginners:
1. [Login](https://github.com/login) to your GitHub account or [create](https://services.github.com/on-demand/intro-to-github/create-github-account) a GitHub account, if you do not already have one.
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).
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 (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/{{yourgithubaccount}}/iD
7. Follow this [Article about Pull Requests](https://help.github.com/articles/about-pull-requests/) to create a new pull request for your change