Skip to content

External contributor memo

Jump to bottom
Didier Vojtisek edited this page Sep 7, 2017 · 10 revisions

Useful tip and tricks for external contributors.

Submitting issue

You can use the github issue trackers for submitting bug and feature request. Ideally, if you know that your issue is related to a specific component, open the issue directly in the repository containing the component (this will help to handle it more efficiently). If you don't know which repository, use the tracker of gemoc-studio repository.

TODO : list the repositories and an overview of their content.

Communication

Make sure to have subscribed to the developer mailing list in order to contact all the other contributors (including official commiters) and discuss technical points.

Contributing code

  • Fork the required repositories

  • Make sure to have an Eclipse account and accepted the Eclipse contributor agreement in your profile.

  • Prepare your contribution (ideally in separate branches if you plan to propose several contributions)

  • Make sure that every commit you propose has the Signed-off-by information in the comment

    This can be enforced automatically in eclipse by setting the preferences (in Team>Git>Committing tick the "insert Signed-off-by" check box).

  • Configure your fork to keep synchronization in order to minimize conflicts https://help.github.com/articles/configuring-a-remote-for-a-fork/ and https://help.github.com/articles/syncing-a-fork/

    ⚠️ I advice you to not use "upstream" as name for your remote, because it may lead to confusion in Eclipse user interface where the upstream keyword is also used in the popup menu of local branches in order pull/fetch from the main remote.

    I prefer using "eclipse_upstream" in order to clarify the remotes.

    ex:

dvojtise@ubuntu:~/git/dvojtise/gemoc-studio$ git remote -v
origin	[email protected]:dvojtise/gemoc-studio.git (fetch)
origin	[email protected]:dvojtise/gemoc-studio.git (push)
dvojtise@ubuntu:~/git/dvojtise/gemoc-studio$ git remote add eclipse_upstream [email protected]:eclipse/gemoc-studio.git
dvojtise@ubuntu:~/git/dvojtise/gemoc-studio$ git remote -v
eclipse_upstream	[email protected]:eclipse/gemoc-studio.git (fetch)
eclipse_upstream	[email protected]:eclipse/gemoc-studio.git (push)
origin	[email protected]:dvojtise/gemoc-studio.git (fetch)
origin	[email protected]:dvojtise/gemoc-studio.git (push)
  • Open a Pull Request for your contribution.
Clone this wiki locally