Difference between revisions of "SWTBot/Contributing"
|Line 148:||Line 148:|
Revision as of 05:06, 31 January 2014
|Open Bugzilla tickets|
|Open Gerrit reviews|
- 1 Getting the source
- 2 IDE tips
- 3 Building SWTBot
- 4 Continuous integration
- 5 Sonar
- 6 Submit a contribution
- 7 Committers
- 8 Contribute changes to website
- 9 Release process
Getting the source
You can use a git mirror of that repository:
To contribute changes to the website, use this git repo: https://git.eclipse.org/c/www.eclipse.org/swtbot.git
Recommended Eclipse plugins
It's advised that you use the following plugins in Eclipse:
- FindBugs (with a high "Minimum rank to report" set in Window > Preferences > Java > Findbugs)
- Configure JDT in "pedantic" mode: from Window > Preferences > Java > Compiler > Errors/Warning make all violations send a warning, ignore nothing.
- EclEmma is useful to analyze Coverage Reports
- ... Any other tool that makes you write better code faster ...
You can find some ready-to-use target platforms for development in the devtools/target-platforms folder. Each target-platform basically target a version of the Eclipse release train. It's recommended to use one of these target-platform since it contains all SWTBot dependencie. These target-platforms are also used at build time, so your dependencies in IDE will be consistent with dependencies during build. Enable the selected target-platform by opening it in IDE with the target definition editor, and click Set As Target Platform.
In case something is not working well, please report them as a bug.
- First Get the sources, as explained a few lines above.
- then mvn clean verify
- That's all!
NOTE: default build performs against Eclipse Indigo. You can test and build against Juno instead by activatin the "juno" profile: mvn clean verify -P juno, and for Kepler, run mvn clean verify -P kepler.
Continuous integrations jobs for SWTBot are available here https://hudson.eclipse.org/swtbot . Here is a quick description of available jobs:
- swtbot-tycho is the main CI job. It builds and run tests against an Eclipse Indigo platform and publishes output p2 repository to http://download.eclipse.org/technology/swtbot/snapshots
- swtbot-tycho-e4.2 compiles and runs tests against the last release of Eclipse 4.x branch. It guarantees compatibility with a wide range of Eclipse versions
- swtbot-gerrit compiles and runs tests against any Gerrit contribution, and then add a vote to the contribution: +1 if everything is fine, -1 in case of a compile error, build error, or failed test
- SWTBot-Sonar runs (weekly) build and tests against last commit of master branch and generates Sonar reports. See #Sonar
- Other swtbot-* are legacy jobs, prior to usage of Maven (2.0.5 and older).
Sonar is used in order to track Code Quality:
- contains results of dedicated build https://hudson.eclipse.org/swtbot/job/SWTBot-Sonar/
Submit a contribution
Patches and contributions are always welcome! There are many general articles about contributing to Eclipse projects:
- How to contribute to Eclipse projects...
- Getting started with Eclipse plug-ins: contributing to Eclipse
- How to Fix a Bug in Eclipse
Report a bug or suggest an enhancement
Just create a ticket here: https://bugs.eclipse.org/bugs/enter_bug.cgi?product=SWTBot
- Unresolved Bugzilla tickets: https://bugs.eclipse.org/bugs/buglist.cgi?list_id=2369532;classification=Technology;query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;product=SWTBot
- Open Gerrit reviews: https://git.eclipse.org/r/#/q/status:open+project:swtbot/org.eclipse.swtbot,n,z
- To receive notifications from Gerrit, go to https://git.eclipse.org/r/#/settings/projects , add project swtbot/org.eclipse.swtbot.git and tick all checkboxes for this project to receive notifications.
- To receive notifications from Bugzilla, go to https://bugs.eclipse.org/bugs/userprefs.cgi?tab=email , and add in User watching the following mail: email@example.com.
Provide a contribution using Gerrit
- First, make sure you have agreed and signed the Eclipse Contribution CLA.
- Then, read carefully this documents: Gerrit to set up commit hooks and other things. We recommand using the EGit-Gerrit connector. Make sure that the options Add Signed-off by and Compute Change-Id for Gerrit Code-Review are selected in the commit dialog.
In case you work without EGit Gerrit connector:
- Make your change locally, and git commit them in your local repo. Commit message must contain Bug Number.
- when you're ready, git push your change to Gerrit using the following command: git push ssh://firstname.lastname@example.org:29418/swtbot/org.eclipse.swtbot.git HEAD:refs/for/master
- After the push, log tells you about a URL which tracks the contribution
In any case
- Share this URL on the bug you're working on.
Provide a patch (Deprecated in favor of Gerrit)
In order to provide a patch, follow the following process:
- git checkout branch_you_want_to_edit
- Modify code
- git add your/modified/file1 your/modified/file2 ...
- git commit Put number of the bug you are working on at the beginning of commit message
- git format-patch HEAD^
- Attach generated patch to the bug you want to contribute to.
- Committer must subscribe to notifications to not miss a contribution. See how to set up nofications
- Committer have to use Gerrit too and follow same process as contributors. They can approve their own contributions, but asking review from another contributor is a cool thing.
- A Gerrit contribution is automatically merged when all "acceptance flags" (Verification, review, IP) are OK.
Contribute changes to website
Website can also be edited using Git and Gerrit process mentioned about for sources:
- Gerrit repo is https://git.eclipse.org/r/p/www.eclipse.org/swtbot.git
- Make sure upcoming release is listed in http://projects.eclipse.org/projects/technology.swtbot/releases
- Announce wish to release on swtbot-dev mailing-list, and wait for approval of committers
- Run all builds on Hudson (swtbot-tycho, swtbot-tycho-e42, swtbot-sonar).
- Keep the build and Tag then with the version of the release using Hudson UI.
- Tag source
$ git fetch eclipse master $ git checkout FETCH_HEAD $ git tag 2.1.1 -m "SWTBot 2.1.1 release" $ git push gerrit 2.1.1
- Once all CI builds are done, go on build.eclipse.org, copy make the release available
$ ssh email@example.com $ cd download/technology/swtbot $ cp snapshots releases/2.1.1 $ rm -r releases/latest $ cp releases/2.1.1 releases/latest
- Change all pom.xml, MANIFEST.MF and feature.xml to use the version of next release, git commit and push
- Change bugzilla milestones (from portal.eclipse.org) to create a new release (2.1.1) and a new milestone (2.1.2)
- Update wiki pages SWTBot#Update Sites and SWTBot/Releases
- Announce release on swtbot-dev mailing-list and SWTBot forum
Hi all, We're happy to announce you the release of SWTBot 2.2.0. Main changes are: * Introduction of UI to assist in usage of test Recorder (cf http://wiki.eclipse.org/SWTBot/Recorder#I.27m_using_an_IDE_to_write_test ) * Branding * Introduction of a drag'n'drop APO The full list of changes can be found here: https://bugs.eclipse.org/bugs/buglist.cgi?list_id=6242414&classification=Technology&query_format=advanced&target_milestone=2.2.0&product=SWTBot Git tag can be found here: http://git.eclipse.org/c/swtbot/org.eclipse.swtbot.git/tag/?id=2.2.0 And release p2 repository can be found here http://download.eclipse.org/technology/swtbot/releases/2.2.0 (and http://download.eclipse.org/technology/swtbot/releases/latest ). Big thanks to everyone who contributed to this release in any way. Very big thanks to the people who contributed code in this release: Rohi Agrawal, Michal Borek, Marcel Hoetter, Mickael Istria, Kristine Jetzke, Jan Koehnlein, Ingo Mohr, Frank Schuerer, Robin Stocke, Rastislav Wagner. Enjoy!
- Update Bugzilla to add the released version as a "Version" and the next version as a "milestone".