Mylar Contributor Reference
Those interested in contributing should start out by emailing
mylar-dev@eclipse.org in order to get
an idea of the current priorities. Also refer to the list of
reports marked help wanted.
- Building Mylar feature from HEAD requires
the latest Eclipse milestone release and
JDK 1.5.
Associate the J2SE-1.5 with your installed JRE on the Execution Environments preference page.
- In the CVS Repositories view, add the following CVS location:
HOST = dev.eclipse.org Repository Path:
/cvsroot/technology.
If you do not have an account you may enter anonymous for the user name
and leave the password blank.
- Check out all of the projects under org.eclipse.mylar (except mylar.jira,
mylar.sandbox, mylar.viz, and mylar.zest.* which have additional
dependencies). There should be no errors or warnings.
- Run org.eclipse.mylar.tests.AllTests as a JUnit Plug-in Test, with
assertions enabled. All tests should pass and there should be no
console output.
Each component has it's own All<Component>Tests suite, and all can be run
via org.eclipse.mylar.tests.AllTests.
- Add the following to the test configuration under Arguments -> VM
Arguments: -enableassertions -Xmx384M
- Add a credentials.properties file to
org.eclipse.mylar.bugzilla.tests, and define "username: xxx" and
"password: yyy" in it. Email mylar-dev@ecipse.org for a username and
password.
- Get the latest
Subclipse plug-in, e.g. from the following update site:
subclipse.tigris.org/update_1.0.x
- Set up a Subversion repository for
JIRA Dashboard (see the
JIRA
Dahsboard doc for troubleshooting):
- Check out the JIRA Dashboard Core features:
- org.tigris.jira.core
- org.tigris.jira.core.soap
- org.tigris.jira.core-feature
- Create a working set that excludes org.tigris.jira plug-ins
so that you have no warnings in the Problems list
- Note that the JIRA connector has it's own test suite:
org.eclipse.mylar.jira.tests.AllJiraTests
- Get the latest
Subclipse plug-in, e.g. from the following update site:
subclipse.tigris.org/update_1.0.x
- Set up a Subversion repository for
oss.steffenpingel.de:
- Check out the library which is required by the connector:
- Note that the Trac connector has it's own test suite:
org.eclipse.mylar.trac.tests.AllTracTests
Working bootstrapped (i.e. self-hosted) makes eating your own dog food easier
and avoids having to update to dev builds:
- Set up a fresh workspace launched from an Eclipse that does not have
Mylar installed, and check out Mylar into
it.
- Create a new Launch Configuration, point it at your workspace,
and work in that. Note that the launching workspace will typically
consume very little memory.
- Whenever your changes make it into HEAD close your runtime
workspace, update from CVS, and then re-launch. It is possible to
run in debug mode so that the changes apply to the workspace immediately
after synch, but this can cause problems with the running workspace if
classes change or go missing.
All contributions to Mylar including patches should be made by using
Mylar in order to ensure that we
eat our our
own dog food. A task context should be attached to each patch to
make applying and evolving it easier.
- Each patch should correspond to a single bug report, and a single
patch should be made for each set of changes to be reviewed.
- With few exceptions patches should be accompanied by a JUnit test,
and in general unit tests are one of the most valuable and long-lived
contributions. If you are having trouble writing a test (e.g.
trickiness verifying what happens in the UI) comment on the
corresponding bug report so that we can point you at similar test cases
or consider extending the test harness if needed.
- Minimize the amount of changes to existing code to make review
easier.
- Synchronize often to ensure you have the latest code. Once you
start modifying resources, put the Synchronize view in Outgoing mode and press
the Change Set button so that Mylar tracks the context for the patch.
- Before creating a new JUnit test class class check the components test
suite for similar test cases (e.g.
AllTasklistTests).
- Set the formatter by importing org.eclipse.mylar/developer/javaFormatterSettings.xml
into Window -> Preferences -> Java -> Code Style -> Formatter.
Format code using Eclipse's formatter (Ctrl+Shift+F)
and ensure that no have been added.
- Add an @author tag to each class that you create.
- Ensure that there is no console output. For logging errors use
MylarStatusHandler.
To submit:
- Ensure there are no build errors, warnings, and that org.eclipse.mylar.tests.AllTests passes.
- Synchronize using Incoming mode and ensure that there are no
conflicts, and merge them locally if there are.
- Right click the task context change set (or the project containing
the patch--patches should be made for a project, not a file), press Team
-> Create Patch, and make the file suffix ".txt".
- Attach the patch to the bug report, and indicate in the comment
what testing was done to validate it (e.g. unit test coverage,
manual tests performed).
- Attach the task context to the bug report.
- Using PDE Build support to create a Mylar distribution from HEAD, using
a plain Eclipse 3.2
- org.eclipse.mylar-feature/feature.xml -> Overview -> change version
number to current date (e.g. 0.4.7.v20060125-0800)
- On Plug-ins tab -> Versions... -> Force feature version into plug-in and
fragment manifests
- Repeat above for org.eclipse.mylar-bugzilla-feature.xml
- org.eclipse.mylar-site/e3.2/site.xml
- Delete old features (grayed out)
- Add new mylar-bugzilla and mylar features
- Hit Build All (if this fails restart Eclipse and try again)
- To install, add the path of org.eclipse.mylar-site/e3.2/site.xml as a
local update site
- Bugzilla support can be built independently of the Mylar UI by checking
out the following projects mylar.bugzilla.core, mylar.bugzilla.ui,
mylar.tasklist, mylar.core
Merging and building the 3.1 branch:
- Right-click the org.eclipse.mylar.java, mylar.ide, and mylar.xml
project, Team -> Switch to Another Branch..., then Refresh the
Branches
and select e_3_1
- The list of files that should not be overwritten is in:
org.eclipse.mylar-site/merge.text
Deploying:
- Instructions are in org.eclipse.mylar-site/release.txt
- Create a new CVS location: dev.eclipse.org:/cvsroot/org.eclipse
- Check out www/mylar as a project
- To push documentation from org.eclipse.mylar.doc to the web site use the
targets in mylar/build.xml