Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide/How To- Code Contributing"

(Create the page from V Lorenzo work)
 
(How to add a Task (Papyrus Bugzilla usage))
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
*'[' ''Category'' ']' ''NameOfTheTask''<br>
 
*'[' ''Category'' ']' ''NameOfTheTask''<br>
  
The category helps to filter the bugs for developers. There are already some existing categories: General, XXX Diagram, Common, Property View, etc.  
+
The category helps to filter the bugs for developers. There are already some existing categories: General, XXX Diagram, Common, Property View, etc.
 +
 
 +
As a reminder, the lifecycle of bugs is located here: [[Development Resources/HOWTO/Bugzilla Use|Bugzilla Use]]
 +
 
 +
=== How to contribute code with Gerrit (non commiter)  ===
 +
 
 +
If you want to contribute code, and you are not a commiter, here is how to proceed [[Papyrus Developer Guide/How to Contribute to Papyrus with Gerrit]]
  
 
=== How to contribute a patch  ===
 
=== How to contribute a patch  ===
Line 19: Line 25:
 
*(3) I have the right to contribute the code to Eclipse.  
 
*(3) I have the right to contribute the code to Eclipse.  
 
*(4) I contribute the content under the EPL.
 
*(4) I contribute the content under the EPL.
 +
 +
+ Set the field Review to '?'.
  
 
=== How to commit a patch  ===
 
=== How to commit a patch  ===
Line 50: Line 58:
 
**your code is formatted using the Papyrus Template  
 
**your code is formatted using the Papyrus Template  
 
**each file has an header with the EPL licence and your name  
 
**each file has an header with the EPL licence and your name  
**all strings are externalized
+
**all strings are externalized or tagged with //$NON-NLS-1$
  
 
*Moreover, if you want to commit a patch, please see the point "How to commit a patch".
 
*Moreover, if you want to commit a patch, please see the point "How to commit a patch".

Revision as of 03:23, 28 January 2015

Code Contribution

How to add a Task (Papyrus Bugzilla usage)

When adding a task to the buzilla, the following grammar should be used:

  • '[' Category ']' NameOfTheTask

The category helps to filter the bugs for developers. There are already some existing categories: General, XXX Diagram, Common, Property View, etc.

As a reminder, the lifecycle of bugs is located here: Bugzilla Use

How to contribute code with Gerrit (non commiter)

If you want to contribute code, and you are not a commiter, here is how to proceed Papyrus Developer Guide/How to Contribute to Papyrus with Gerrit

How to contribute a patch

(For further information, see http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf)

When a non-committer wants to contribute to Papyrus, he must create patchs and attach them to a bug. In the comment of each patch, he must write :

  • (1) I, Forename Name, wrote 100% of the code I've provided.
  • (2) This code contains no cryptography
  • (3) I have the right to contribute the code to Eclipse.
  • (4) I contribute the content under the EPL.

+ Set the field Review to '?'.

How to commit a patch

Before commiting a patch, you should verify that the contributor has written the following lines in the comment :

  • (1) I, Forename Name, wrote 100% of the code I've provided.
  • (2) This code contains no cryptography
  • (3) I have the right to contribute the code to Eclipse.
  • (4) I contribute the content under the EPL.

If not, he must do that before you commit its patch!

  • If the writer is an employee of the same company and if the compagny has signed a Member Commiter Agreement : after the commit, you should comment the attachment writing :
    • Here is a contribution from one employee of "the name of the company"
    • The company has signed a Member Commiter Agreement.
    • The contribution does not need a CQ.
    • I've committed this contribution.
    • Committed revision xxx.
    • Set the field iplog to +

Note : In reality, you should have the autorization of the PMC before doing this commit.

How to commit code

  • Before to commit, you should verify these items :
    • your code is formatted using the Papyrus Template
    • each file has an header with the EPL licence and your name
    • all strings are externalized or tagged with //$NON-NLS-1$
  • Moreover, if you want to commit a patch, please see the point "How to commit a patch".
  • During the commit :
    • you should comment your commit and precise the id of the bug
  • After the commit
    • Write the following comment in the bug : Commited in Rxxx

Back to the top