Skip to main content

Edapt - Getting Involved

There are different ways to get involved:

  • File a bug - file bugs and feature requests
  • Github - use Github Pull Requests to create and submit your patches

How to setup your IDE

  • Get the latest Eclipse Modeling Tools for your platform.
  • Download the Zip of the latest Edapt release from the download section
  • In your IDE go to Preferences => Plug-In Development => API Baselines and set the unzipped Edapt release as the API Baseline.
  • Check out the Edapt source code from

    https://github.com/eclipse-edapt/edapt.git (HTTPS)

    or

    git@github.com:eclipse-edapt/edapt.git (SSH)

  • Import the source code and set the edapt_with_cdo.target target.

Commit Message Guidelines

We have the following commit message template:

(Bug <Bug ID> - <Bug Title>) | (TCI - <Fix>)

<Commit Description>?
Signed-off-by: <sign off name and email>
			
Instructions (Please continue READING):
  • TCI commits: For trivial code changes please use a TCI commit message. See list below for examples. If in doubt please discuss with reviewer.
  • Normal Commits: For all other commits use a commit message starting with 'Bug'. Bug reports with Proper Titles: Before using a Bug title for a commit, committer must update the Bug title to a reasonable and descriptive title for the task they have worked on
  • Commit Description: Additionally to the title, the commit message can describe briefly (2-3 sentences) how this commit fixes the bug from a technical perspective
  • Multiple Commits for same bug: Of course you may use the same bug and therefore bug title for multiple commits and their message, in this case please provide a unique description
  • Reviewers responsibility: The reviewer is responsible also for checking that the bug title is descriptive and reflects the committed change and that the description if any reflects the technical change
TCI message examples:
  • JavaDoc
  • NPE
  • Version Update of manifest and pom
  • anonymous to inner class Conversion
  • Renaming local vars, e.g. because of typos
  • Externalizing strings

Back to the top