Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BPMN2-Modeler/DeveloperTutorials/HowToStartContributing"
(→Clone the Git Repository) |
(→Commit your Changes) |
||
| Line 66: | Line 66: | ||
2.) If you not yet have an existing issue ID in [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=BPMN2Modeler Bugzilla], start creating a new issue first. | 2.) If you not yet have an existing issue ID in [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=BPMN2Modeler Bugzilla], start creating a new issue first. | ||
| − | 3.) Now you can | + | 3.) Now you can submit your changes. Add the Bugzilla ID into your commit comment like 'Bug xxxxxx' |
and finally push your changes. You can track the review process via the Gerrit Link listed in your bugzilla issue. | and finally push your changes. You can track the review process via the Gerrit Link listed in your bugzilla issue. | ||
Revision as of 19:39, 12 May 2017
If you want to contribute to this project, you can find a short tutorial below how to start:
Contents
Report a Bug
Frist of all take a look into the Issue Tracker of the BPMN2 Modeler project. There you can find current issues we are working on and we are pleased if you will help us here.
You can also report a new issue here.
Clone the Git Repository
If you want to debug the BPMN2 Modeler project or to start your own contribution you can checkout the latest development branch from the Git source code repository. You will find the repository here.
To clone the git repository use just one of the following git urls:
- git://git.eclipse.org/gitroot/bpmn2-modeler/org.eclipse.bpmn2-modeler.git
- ssh://git.eclipse.org/gitroot/bpmn2-modeler/org.eclipse.bpmn2-modeler.git
- http://git.eclipse.org/gitroot/bpmn2-modeler/org.eclipse.bpmn2-modeler.git
all these URLs point to the same repository but use different protocols. The GIT protocol should be a good choice.
When you clone the repository you will find a lot of branches. In most cases it is sufficient to checkout only the master branch or the branch pointing to one of the Eclipse major releases (e.g. mars, neon,...)
Note: The master branch contains the release for the next Eclipse version. For the current Eclipse IDE checkout the corresponding branch.
Import the BPMN2 Modeler project into your Workspace
Now you can import the BPMN2 Modeler project into your workspace
Choose "Import -> Maven -> existing maven project"
and select your local repository location (e.g. ~/git/org.eclipse.bpmn2-modeler/)
Next you can open the plugin.xml file from the subproject 'org.eclipse.bpmn2.modeler.core project'
Here you can start the plugin directly from your IDE. You can also launch the plugin in the debug mode.
Commit your Changes
As far as committing changes to the git repo, you should be able to just push to gerrit, and this will create a change record for review. Please have a look at the Gerrit Wiki Page if you run into problems.
1.) Use the following Git repository URL:
ssh://[USER ID]@git.eclipse.org:29418/bpmn2-modeler/org.eclipse.bpmn2-modeler.git
where [USER ID] is your committer user id.
2.) If you not yet have an existing issue ID in Bugzilla, start creating a new issue first.
3.) Now you can submit your changes. Add the Bugzilla ID into your commit comment like 'Bug xxxxxx' and finally push your changes. You can track the review process via the Gerrit Link listed in your bugzilla issue.