Jump to: navigation, search

Difference between revisions of "CDT/contributing"

< CDT
(Sending Patches)
(14 intermediate revisions by 7 users not shown)
Line 3: Line 3:
 
To make changes to the CDT, whether it be code, docs, JUnits, etc., you will need to send patches to the source stored on eclipse.org. Here is the process for sending patches.
 
To make changes to the CDT, whether it be code, docs, JUnits, etc., you will need to send patches to the source stored on eclipse.org. Here is the process for sending patches.
  
# Create a workspace in Eclipse for your work. Check out the CDT plugins you'd like to work on into it. The plugins are on <tt>dev.eclipse.org</tt>, <tt>/cvsroot/tools</tt>. The plugins are under folder <tt>org.eclipse.cdt/all</tt>. There should be around 40 plugins there that you need to check out.
+
* To fix anything in CDT first you need to create or find an existing [https://bugs.eclipse.org/bugs/ bugzilla] report for this particular problem/enhancement
# Edit and test your change. This is basic Eclipse plugin development. There are a number of resources on the web and in the Eclipse help system on how to do this.
+
* Setup your eclipse SDK and check out source code, see [[Getting started with CDT development]] article.
# Use the Eclipse Team menu to create a patch (click <b>Team > Create Patch</b>). Ensure that all the modified plugins are included when creating the patch. In Eclipse 3.2 you can create a patch for your whole workspace. For Eclipse 3.1, you will need to create a patch for each plugin you've changed.
+
* Fix the source code
# Attach the patch or patches to a bugzilla entry. Make sure you check off the patch box to help us find patches.
+
* Comment your changes in the code
# Send mail to the [mailto://cdt-patch@eclipse.org cdt-patch] list to let the committer's know there is a patch ready.
+
* If the changes are significant add your name and company in the contributor list in the file header. For new files you must add copyright header: http://wiki.eclipse.org/CDT/policy#Copyright
 +
* Follow [[CDT/policy|CDT Guidelines]] for code formating and java warnings/errors
 +
** Externalize strings (excluding exception arguments, tests and special identifiers)
 +
** Check for API errors (you have to setup API tooling, see [[CDT/policy#Using_API_Tooling]])
 +
** Code with any of the warnings/errors mentioned in the policy, including strings externalization and API errors will not be accepted.
 +
* To minimize the change, do not re-format the source code you edited (except changed lines). Do not fix any warnings in the code you are not changing
 +
* If you really want to do formatting or styling (such as converting to java 1.5) - create another bug for that and attach a patch(it is good to fix warnings but it would clutter the patch, you want to solve one problem at a time).
 +
* To speed up process of applying your changes you should create one or more junit tests as well and include it in your change
 +
* Gerrit is now used by the CDT project for contributions, follow the steps [[CDT/git#Using_Gerrit_for_CDT|here]] to submit your changes to Gerrit. If you still want to create a patch, follow the steps [[CDT/git#Posting_patches_on_Bugzilla|here]].
 +
* Check size of the contribution, if it is more than 250 lines see copyright section below
 +
* Patch only:
 +
** If you have new or changed binary files such as icons, attach them separately and indicate where do they go
 +
** Submit patch using an attachment to a bug report
 +
** Mark attachment as a patch
 +
** If previous patches attached to the bug, which are obsolete now mark them as such
 +
** Add a comment to which branch the patch should  be applied (HEAD by default)
 +
** Add a comment on what patch is doing, it is not easy to figure it out from the code
 +
* Gerrit only:
 +
** Post a new comment in the bug report containing a link to the Gerrit so that people watching the bug know the a change has been posted for review, for example https://git.eclipse.org/r/#/c/8327/
 +
* Make sure bug report has a clear reproducible scenario, if not add one
 +
* Normally committees are watching new Bugzilla/Gerrit activity and somebody would look at your contribution in a few days
 +
* If it has not received attention in a week or so, some nagging can help. Send email to mailto:cdt-dev@eclipse.org asking committers to look at the contribution. Continue sending e-mails until somebody would give up and look.
  
One of the fundamental rules that Eclipse follows is the ability to trace back who contributed what code and that the person who contributed it has ownership of the code, or has permission from their employer to contribute the code (since employers tend to own everything you write). To help keep this IP integrity going, please ensure your contributions are "clean".
 
  
See the [https://dev.eclipse.org/mailman/listinfo/cdt-patch cdt-patch info] page for more information.
+
One of the fundamental rules that Eclipse follows is the ability to trace back who contributed what code and that the person who contributed it has ownership of the code, or has permission from their employer to contribute the code (since employers tend to own everything you write). To help keep this IP integrity going, please ensure your contributions are "clean".
 
+
* If you copy ANY code or images from somewhere else please clearly state it
== Tips ==
+
* If you copy GPL code we cannot take it
 
+
* If you copy EPL code, preserve the original copyright and contributors
* If you are behind a firewall, you can use the proxy server at <tt>eclipse.org</tt> to access the CVS repository using pserver on the <tt>proxy.eclipse.org</tt> and port 80.
+
* If your changes are more than 250 lines of code patch has to go through IP review process, unless it can be applied by the committer from the same company as you are. Nobody wants to do it so please avoid it. Try to fix one bug at a time.
 +
** (I assume "lines of code" - they exclude comments, xml and properties files)
  
 
[[Category:CDT]]
 
[[Category:CDT]]

Revision as of 18:12, 23 November 2012

Sending Patches

To make changes to the CDT, whether it be code, docs, JUnits, etc., you will need to send patches to the source stored on eclipse.org. Here is the process for sending patches.

  • To fix anything in CDT first you need to create or find an existing bugzilla report for this particular problem/enhancement
  • Setup your eclipse SDK and check out source code, see Getting started with CDT development article.
  • Fix the source code
  • Comment your changes in the code
  • If the changes are significant add your name and company in the contributor list in the file header. For new files you must add copyright header: http://wiki.eclipse.org/CDT/policy#Copyright
  • Follow CDT Guidelines for code formating and java warnings/errors
    • Externalize strings (excluding exception arguments, tests and special identifiers)
    • Check for API errors (you have to setup API tooling, see CDT/policy#Using_API_Tooling)
    • Code with any of the warnings/errors mentioned in the policy, including strings externalization and API errors will not be accepted.
  • To minimize the change, do not re-format the source code you edited (except changed lines). Do not fix any warnings in the code you are not changing
  • If you really want to do formatting or styling (such as converting to java 1.5) - create another bug for that and attach a patch(it is good to fix warnings but it would clutter the patch, you want to solve one problem at a time).
  • To speed up process of applying your changes you should create one or more junit tests as well and include it in your change
  • Gerrit is now used by the CDT project for contributions, follow the steps here to submit your changes to Gerrit. If you still want to create a patch, follow the steps here.
  • Check size of the contribution, if it is more than 250 lines see copyright section below
  • Patch only:
    • If you have new or changed binary files such as icons, attach them separately and indicate where do they go
    • Submit patch using an attachment to a bug report
    • Mark attachment as a patch
    • If previous patches attached to the bug, which are obsolete now mark them as such
    • Add a comment to which branch the patch should be applied (HEAD by default)
    • Add a comment on what patch is doing, it is not easy to figure it out from the code
  • Gerrit only:
    • Post a new comment in the bug report containing a link to the Gerrit so that people watching the bug know the a change has been posted for review, for example https://git.eclipse.org/r/#/c/8327/
  • Make sure bug report has a clear reproducible scenario, if not add one
  • Normally committees are watching new Bugzilla/Gerrit activity and somebody would look at your contribution in a few days
  • If it has not received attention in a week or so, some nagging can help. Send email to mailto:cdt-dev@eclipse.org asking committers to look at the contribution. Continue sending e-mails until somebody would give up and look.


One of the fundamental rules that Eclipse follows is the ability to trace back who contributed what code and that the person who contributed it has ownership of the code, or has permission from their employer to contribute the code (since employers tend to own everything you write). To help keep this IP integrity going, please ensure your contributions are "clean".

  • If you copy ANY code or images from somewhere else please clearly state it
  • If you copy GPL code we cannot take it
  • If you copy EPL code, preserve the original copyright and contributors
  • If your changes are more than 250 lines of code patch has to go through IP review process, unless it can be applied by the committer from the same company as you are. Nobody wants to do it so please avoid it. Try to fix one bug at a time.
    • (I assume "lines of code" - they exclude comments, xml and properties files)