Review rules - eclipse-capella/capella GitHub Wiki

Format

Commit message

Commit message shall contains Signed-Off and a reference to the issue.

#ISSUE Description

Signed-Off: user <mail>

Copyright headers

All files shall contains a copyright

New files

New Image

When a new image is added, it shall have an EPL-2 license. (not being copied from anywhere on internet but be a new image or be copied/modified from an image already existing in Capella/Eclipse)

The image path shall be referenced in a license.txt located aside The license.txt file contains a link towards the original image (if image has been copied from somewhere)

💚 /icons/full/obj16/CtxModelFile.gif - org.eclipse.emf.edit - org.eclipse.emf.edit/icons/full/obj16/ModelFile.gif

New plugin

When developer adds a new plugin, it shall contains an about.html containing the license.

Those files shall be referenced on the build.properties to be included in the final product.

New feature

When developer adds a new feature, it shall contains

Those files shall be referenced on the build.properties to be included in the final product.

Externalize Strings

All strings displayed to the user shall be externalized to a Messages.java class. see example

String message = "Please select a file"

💚 String message = Messages.SELECT_FILE

Usage of interfaces

Usage of implementations doesn't work on Team for Capella

SystemFunctionImpl sf = (SystemFunctionImpl)object;

💚 SystemFunction sf = (SystemFunction)object;

Commented code must be deleted.

Comments shall be used to explain code if necessary, not to comment code. Developer must not comment code but delete it.

//EObject element = (EObject) someWeirdCodeThatIDontUnderstand;
EObject element = (EObject) newCode;

💚 EObject element = (EObject) newCode;

Dead code

Developer shall delete dead code if encountered.

if (false) 
   doStuff
EObject element = (EObject) someWeirdCodeThatIDontUnderstand;

💚 EObject element= (EObject) newCode;

Code format

Developer must use the capella.epf file to format its code.

EObject element=(EObject)newCode;

💚 EObject element = (EObject) newCode;

⚠️ **GitHub.com Fallback** ⚠️