Jump to: navigation, search

Difference between revisions of "SWTBot/Contributing"

(Bug list)
(Target Platform)
(13 intermediate revisions by the same user not shown)
Line 8: Line 8:
  
 
You can also browse the repository using [https://git.eclipse.org/c/swtbot/org.eclipse.swtbot.git/ a web interface] or even by monitoring the [https://github.com/eclipse/swtbot mirror of the repository on GitHub].
 
You can also browse the repository using [https://git.eclipse.org/c/swtbot/org.eclipse.swtbot.git/ a web interface] or even by monitoring the [https://github.com/eclipse/swtbot mirror of the repository on GitHub].
 +
 +
To contribute changes to the website, use this git repo: <tt>https://git.eclipse.org/c/www.eclipse.org/swtbot.git</tt>
 +
 +
== IDE tips ==
 +
=== Recommended Eclipse plugins ===
 +
It's advised that you use the following plugins in Eclipse:
 +
* EGit
 +
* FindBugs
 +
* Configure JDT in "pedantic" mode (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 ...
 +
 +
=== Target Platforms ===
 +
 +
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.
  
 
== Building SWTBot ==
 
== Building SWTBot ==
  
 
# First Get the sources, as explained a few lines above.
 
# First Get the sources, as explained a few lines above.
# then <tt>mvn clean install</tt>
+
# then <tt>mvn clean verify</tt>
 
# That's all!
 
# That's all!
  
Line 25: Line 42:
 
A view also exists, it contains also older build configurations: https://hudson.eclipse.org/hudson/view/SWTBot/
 
A view also exists, it contains also older build configurations: https://hudson.eclipse.org/hudson/view/SWTBot/
  
== Contributing ==
+
== Sonar ==
 +
 
 +
Sonar is used in order to track Code Quality:
 +
* https://dev.eclipse.org/sonar/dashboard/index/1
 +
* contains results of dedicated build https://hudson.eclipse.org/sandbox/job/SWTBot-Sonar/
 +
 
 +
== Submit a contribution ==
  
 
=== Generalities ===
 
=== Generalities ===
Line 36: Line 59:
 
=== Contributions list ===
 
=== Contributions list ===
  
* 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
+
* 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
+
* Open '''Gerrit''' reviews: https://git.eclipse.org/r/#/q/status:open+project:swtbot/org.eclipse.swtbot,n,z
  
 
=== Be notified ===
 
=== Be notified ===
  
==== From Gerrit ====
+
* 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: ''swtbot-inbox@eclipse.org''.
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.
+
 
+
==== From Bugzilla ====
+
 
+
To receive notifications from Bugzilla, go to https://bugs.eclipse.org/bugs/userprefs.cgi?tab=email , and add in '''User watching''' the following mail: ''swtbot-inbox@eclipse.org''.
+
  
=== Use Gerrit ===
+
=== Provide a contribution using Gerrit ===
  
 
# First, read '''carefully''' this documents: [[Gerrit]] to set up commit hooks and other things. We recommand using the [[Gerrit#Using_Gerrit_with_EGit: | EGit-Gerrit connector]].
 
# First, read '''carefully''' this documents: [[Gerrit]] to set up commit hooks and other things. We recommand using the [[Gerrit#Using_Gerrit_with_EGit: | EGit-Gerrit connector]].
 
In case you work without EGit Gerrit connector:
 
In case you work without EGit Gerrit connector:
# Make your change locally, and ''git commit'' them in your local repo
+
# 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: <tt>git push ssh://username@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git HEAD:refs/for/master</tt>
 
# when you're ready, ''git push'' your change to Gerrit using the following command: <tt>git push ssh://username@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git HEAD:refs/for/master</tt>
 
# After the push, log tells you about a URL which tracks the contribution
 
# After the push, log tells you about a URL which tracks the contribution
Line 71: Line 89:
 
== Committers ==
 
== Committers ==
  
* Committer must subscribe to notifications to not miss a contribution. See [[#Be Notified|how to set up nofications]]
+
* Committer must '''subscribe to notifications''' to not miss a contribution. See [[#Be Notified|how to set up nofications]]
* It's recommanded that committer use Gerrit too and follow same process as contributors
+
* 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.
* Push change to ''ssh://userid@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git''
+
* A Gerrit contribution is automatically merged when all "acceptance flags" (Verification, review, IP) are OK.
  
== See also ==
+
== Editing website ==
  
* {{SWTBotLink|Maintaining SWTBot Versions For Your Team|Maintaining SWTBot Versions For Your Team}}
+
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
  
 
[[Category:Draft Documentation]]
 
[[Category:Draft Documentation]]

Revision as of 13:57, 28 March 2013


SWTBot
Website
Update Sites
Community
Mailing List
Forums/Newsgroups
IRC
Contribute
Open Bugzilla tickets
Open Gerrit reviews
Browse Source
Continuous Integration


Getting the source

You can use a git mirror of that repository:

git clone git://git.eclipse.org/gitroot/swtbot/org.eclipse.swtbot.git

You can also browse the repository using a web interface or even by monitoring the mirror of the repository on GitHub.

To contribute changes to the website, use this git repo: https://git.eclipse.org/c/www.eclipse.org/swtbot.git

IDE tips

Recommended Eclipse plugins

It's advised that you use the following plugins in Eclipse:

  • EGit
  • FindBugs
  • Configure JDT in "pedantic" mode (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 ...

Target Platforms

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.

Building SWTBot

  1. First Get the sources, as explained a few lines above.
  2. then mvn clean verify
  3. 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 install -P juno

Continuous integration

Continuous integrations build for swtbot are available here:

A view also exists, it contains also older build configurations: https://hudson.eclipse.org/hudson/view/SWTBot/

Sonar

Sonar is used in order to track Code Quality:

Submit a contribution

Generalities

Patches and contributions are always welcome! There are many general articles about contributing to Eclipse projects:

Contributions list

Be notified

Provide a contribution using Gerrit

  1. First, read carefully this documents: Gerrit to set up commit hooks and other things. We recommand using the EGit-Gerrit connector.

In case you work without EGit Gerrit connector:

  1. Make your change locally, and git commit them in your local repo. Commit message must contain Bug Number.
  2. when you're ready, git push your change to Gerrit using the following command: git push ssh://username@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git HEAD:refs/for/master
  3. After the push, log tells you about a URL which tracks the contribution

In any case

  1. 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:

  1. git checkout branch_you_want_to_edit
  2. Modify code
  3. git add your/modified/file1 your/modified/file2 ...
  4. git commit Put number of the bug you are working on at the beginning of commit message
  5. git format-patch HEAD^
  6. Attach generated patch to the bug you want to contribute to.

Committers

  • 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.

Editing website

Website can also be edited using Git and Gerrit process mentioned about for sources: