Contributor Information

There are several ways you can contribute to the ArcGIS Editor for OpenStreetMap project, as described below. For details about the current in-work source code, see Code In-Progress Notes.

Log an Issue

Users are encouraged to submit bugs and feature requests to the ArcGIS Editor for OpenStreetMap project. We would like to work together with the community to improve the ArcGIS Editor for OpenStreetMap. The steps below will explain the process when submitting an issue.

Issues can be reported at the Issue Tracker page.

The ArcGIS Editor for OpenStreetMap team will review the submitted issues to determine a course of action. The more information the better as this will allow us to reproduce the bug or fully understand the feature request. As decisions are made about whether to include or exclude features, the ArcGIS Editor for OpenStreetMap team will post these to the site to keep contributors informed and allow contributors to elaborate on their requests.

Contribute to the Project

You can contribute to the project by submitting a Patch. The Patch is a file that contains only differences between two sets of files (old vs. new or original vs. update) in such a way that the patch can be applied to other source code files with the same command.

To create a patch, contributors need to use the SVN diff/patch command. For Windows, SVN clients such as TortoiseSVN support this. For Linux, contributors can use console linux commands diff/patch to achieve these.

To create a patch is simple:
  1. A contributor first synchronizes their local copy with Source Forge site to get the latest code, and make proper fixes/changes in the local copy.
  2. By using diff command (for linux) or "create a patch" in the Tortoise context menu, create a patch file on the right folder level (please consult the requisite SVN or Linux documentation for further information).
  3. Before submitting the create patch, the submitter should test the patch to verify the patch works and it does not break other parts of the ArcGIS Editor for OpenStreetMap project.
  4. The contributor attaches the created patch file to the logged issue. The contributor should explain enough for reviewers to understand the patch and how to test it.

Note: Once a contributor shows their consistent dedication for the ArcGIS Editor for OpenStreetMap project and quality of their work,the ArcGIS Editor for OpenStreetMap team can consider giving write access to that contributor.

Patch Review Process

The patch review process consists of two steps:

Step 1 - Patch testing
One of ArcGIS Editor for OpenStreetMap team members(reviewer) will test the submitted patch by applying the patch to a local copy of the current Source Forge code. Then, the reviewer will verify the bug or feature. For the cases that a patch does not work or what the patch does is not clear, the reviewer notifies the original submitter to clarify the questions or issues, and the current review process will be postponed.

Step 2 - Code review
If a submitted patch passes Step 1, the code and the changes will be reviewed by a group of ArcGIS Editor for OpenStreetMap team members. During the meeting, all the patches for the week will be reviewed by the code review group. For the cases that a patch does not meet quality standard in coding, the ArcGIS Editor for OpenStreetMap team will notify the submitter with feedback. Then, the original submitter can revise their code and resubmit for another iteration of review process. For the cases that a patch passes this review, the patch will be applied to this Codeplex project by an ArcGIS Editor for OpenStreetMap project member who has privileges to commit code.

Previous topic: Documentation
Next topic: What's Next

Last edited Apr 2, 2012 at 11:08 PM by eggwhites, version 11

Comments

No comments yet.