Define development good practices

[mrostren]

Hello all,
@ModelWriter/consortium

This issue is about defining all the development good practices we need to apply on all the MW project plug-ins.

Please feel free to discuss any related detail here.
Regards,
Marwa

---

GOOD PRACTICES:

• In the workspace:
  • Please set the right files encoding : to do so go to Window -> Preferences -> Workspace and choose the UTF-8 encoding instead of the Cp1252 encoding as a default one
  • Please add facilities actions to format well the content of your files: to do so go to Window -> Preferences -> Java -> Editor -> Save Actions and check the box to format all lines of the source code and the Organize Imports box.

This will prevent some merge and rebase problems for other partners working on the same code.

• Github process to keep the history clean and easy to read:
  • Please configure correctly your git to display correctly your name/email commits
  • Please use the command: git pull --rebase instead of merging. This will keep a linear readable history.
  • For all work in progress please make a branch based on the current master branch and named wip/< name of your current task >. Then, when the task progress is finished please rebase on the master branch ensure that other partners are not working on the branch before deleting it from the repository.
  • For each finished deliverable task please create a tag using the deliverable code, name and its milestone as a name (e.g
    D6.1.1-SoftwarePrototypeCoreModelWriter-M6)

The development environment should at least contains:

• eGit (part of Eclipse release)
• checkstyle http://eclipse-cs.sf.net/update/
• Eclemma http://update.eclemma.org/
• EMF (part of Eclipse release)
• find bugs http://findbugs.cs.umd.edu/eclipse/
• target platform dsl http://mbarbero.github.io/fr.obeo.releng.targetplatform/p2/

A graphical testing environment might also be needed:
RCPTT https://www.eclipse.org/rcptt/download/

Eclipse Naming Conventions
Eclipse Version Numbering
Eclipse User Interface Guidelines

To Be Continued during the project lifecycle...

[mrostren]

@ffurkan Hello Furkan, please can you configure correctly your git.
some of your commit display the next as author:
unknown < [email protected] >

Thanks in advance,
Regards

[ferhaterata]

Hi Marwa,

I have realized the issue recently. He has corrected the github name in the machine.

Thanks.

[mrostren]

Thanks for the update

[ferhaterata]

Dear @ylussaud (cc'ed @ModelWriter/consortium)

I have been using the formatter which is proposed by Google in order to be used in open source Eclipse Java projects.

https://github.com/google/styleguide
http://google.github.io/styleguide/javaguide.html

Should we go on with this or Eclipse community has already proposed one?

Here is the file which can be imported through Eclipse preferences:

https://github.com/google/styleguide/blob/gh-pages/eclipse-java-google-style.xml

Best regards,

[ylussaud]

I have a project with code template, format, checkstype, ... I just need to push it. Where can I push it ?

[ferhaterata]

What about here? https://github.com/ModelWriter/Source

[ylussaud]

I pushed the files in releng/eu.modelwriter.parent/codestyle

[ferhaterata]

Thanks.