Skip to main content
Jump to: navigation, search

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

(Code Contribution)
Line 15: Line 15:
 
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]]
 
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  ===
+
=== What to do to contribute a patch  ===
  
 
(For further information, see http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf)  
 
(For further information, see http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf)  
Line 28: Line 28:
 
+ Set the field Review to '?'.
 
+ Set the field Review to '?'.
  
=== How to commit a patch  ===
+
=== What to check before committing a patch  ===
  
 
Before commiting a patch, you should verify that the contributor has written the following lines in the comment :  
 
Before commiting a patch, you should verify that the contributor has written the following lines in the comment :  
Line 53: Line 53:
 
*In all other cases, see http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
 
*In all other cases, see http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
  
=== How to commit code ===
+
=== Code formatting ===
  
 
*Before to commit, you should verify these items :  
 
*Before to commit, you should verify these items :  
 
**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 or tagged with //$NON-NLS-1$
+
**all strings are externalized or tagged with //$NON-NLS-1$. see [[https://wiki.eclipse.org/Papyrus/Papyrus_Developer_Guide#String_Externalization.2FInternalization | this page]] for more informations.
 +
**the version numbers are correcct. see [[https://wiki.eclipse.org/Version_Numbering | this guide]] for more informations.
  
 
*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".
  
*During the commit :
 
**you should comment your commit and precise the id of the bug
 
  
*After the commit  
+
=== Commit message ===
**Write the following comment in the bug : Commited in Rxxx
+
*During the commit :
 +
**you should comment your commit and precise the id of the bug. see [[https://wiki.eclipse.org/Papyrus/Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | this page]] for more information about contributing through git and gerrit.

Revision as of 09:50, 31 January 2018

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

What to do 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 '?'.

What to check before committing 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.

Code formatting

  • 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$. see [| this page] for more informations.
    • the version numbers are correcct. see [| this guide] for more informations.
  • Moreover, if you want to commit a patch, please see the point "How to commit a patch".


Commit message

  • During the commit :
    • you should comment your commit and precise the id of the bug. see [| this page] for more information about contributing through git and gerrit.

Back to the top