Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 4.06 KB
Raw

Guide to contributing

Please read this if you intend to contribute to the project.

Legal stuff

Apologies in advance for the extra work required here - this is necessary to comply with the Eclipse Foundation's strict IP policy.

Please also read Contributing via Git (Eclipse Wiki).

In order for any contributions to be accepted you MUST do the following things.

  • Sign the Eclipse Foundation Contributor License Agreement. To sign the Eclipse CLA you need to:

    • Obtain an Eclipse Foundation userid. Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those. If you don’t, you need to register.

    • Login into the projects portal, select “My Account”, and then the “Contributor License Agreement” tab.

  • Add your github username in your Eclipse Foundation account settings.

  • "Sign-off" your commits

Every commit you make in your patch or pull request MUST be "signed off".

You do this by adding the -s flag when you make the commit(s), e.g.

git commit -s -m "Shave the yak some more"

Create an Issue

Create a GitHub Issue for every significant piece of work ( > 2 hrs).

Create a new branch for your changes

  1. In the Git Repositories tab, expand the texlipse repository.
  2. Right click on the "Branches" node and select "Switch To" -> "New Branch".
  3. Enter the new branch name.
    Branch name should be {GitHubUserName}/{summary or issue id} e.g. erwin/integrate-display-actor.
    Alternative idea is a bit more elaborated : {GitHubUserName}/{ChangeType}/{issue id}/{summary} e.g. jake/ft/5/integrate-display-actor. In this approach change type acronyms can be e.g. ft (feature i.e. with functional value) ; eh (enhancement without functional value) ; bg (bug) ; doc ; ...

Committing

  • Make your changes.
  • Make sure you include tests.
  • Make sure the test suite passes after your changes.
  • Commit your changes into that branch.
  • For files that are in Eclipse packages, right click on the file in the Package Explorer and commit it.
  • For files that are not in Eclipse packages, invoke the Git Staging via Window -> Show View -> Other -> Git -> Git
  • Use descriptive and meaningful commit messages. See git commit records in the Eclipse Project Handbook. Mention issue_id in each commit comment using syntax like "Adapt this interface for #15" to link to issue 15.
  • Make sure you use the sign off your commit.
    • If you are commiting using Eclipse, then click on the signature button
    • If you are invoking git from the command line, then use the -s flag.
    • If you are using some other tool, add Signed-off-by: YourFirstName YourLastName <YourEclipseAccountEmailAddress> For example: Signed-off-by: Christopher Brooks <cxh@eecs.berkeley.edu>
  • Push your changes to your branch in your forked repository.

Submitting the changes

  1. Submit a pull request via the normal GitHub UI to trigger to request feedback / code review / ...
  2. Mention issue_id in each comment using syntax like "Adapt this interface for #15" to link to issue 15 in the initial comment for a Pull Request.
  3. Pay attention to the "Jenkins Build" check, if it fails you will find more information following the "details" link leading to the Eclipse Texlipse Jenkins instance.
  4. The pull request will be reviewed by one of the committers, and then merged into master.

After submitting

  • Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.

Credit

This file is based on a file written by the Vert.x team at https://raw.githubusercontent.com/eclipse/vert.x/master/CONTRIBUTING.md

We have shamelessly copied, modified and co-opted it for our own repo and we graciously acknowledge the work of the original authors.