Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

53 lines (31 loc) · 2.56 KB
Raw

Contributing to Eclipse SmartHome

Thanks for your interest in this project!

You can propose contributions by sending pull requests through GitHub.

And of course you can report issues.

Legal considerations

Please read the Eclipse Foundation policy on accepting contributions via Git.

Your contribution cannot be accepted unless you have an Eclipse Contributor Agreement in place.

Here is the checklist for contributions to be acceptable:

  1. create an account at Eclipse, and
  2. add your GitHub user name in your account settings, and
  3. electronically sign the "Eclipse Contributor Agreement", and
  4. ensure that you sign-off your Git commits, and
  5. ensure that you use the same email address as your Eclipse Foundation in commits.

Technical considerations

Again, check that your author email in commits is the same as your Eclipse Foundation account, and make sure that you sign-off every commit (git commit -s).

Do not make pull requests from your master branch, please use topic branches instead.

When submitting code, please make every effort to follow our coding guidelines in order to keep the code as homogeneous as possible.

Please provide meaningful commit messages.

Here is a sample good Git commit log message:

[666999] Quick summary

This is a discussion of the change with details on the impact, limitations, etc.

Write just like if you were discussing with fellows :-)

Bug: https://github.com/eclipse/smarthome/issues/1
Also-By: Somebody who also contributed parts of this code <foo@bar.com>
Signed-off-by: Yourself <baz@foobar.org>

Never merge changes from the master branch into your topic branch. Always use the rebase command to apply your changes on top of the current master.

Finally, a contribution is not a good contribution unless it comes with unit tests, integration tests and documentation.

Once you have received review comments on your pull request, please address them in additional commits, do not amend your previous commits and squeeze it in there. Several commits help to speed up reviews because it is easier to see the differences. Thus, there is no need to squash any commits because that will be done by a commiter of the project once the pull request will finally be merged.