Common (code) style / formatting ?

[Heiko Rupp]

Hey,

I probably just missed this: do we have some common style rules for code created for Microprofile?

Something like checkstyle rules and editor config files that help with having some unified style 

across the projects? 

Or is this not wanted / desired ?

Thanks

  Heiko

[sst...@redhat.com]

I have just copied what was in the Config project was using for the check style rules:

https://github.com/eclipse/microprofile-config/blob/master/pom.xml

It would be nice if we could codify that in IDE specific style configuration in a common repository as well.

[Heiko Rupp]

There is http://editorconfig.org that can define the formats and which the major IDEs understand

The other option is to use the Eclipse IDE .project(?) file, which Idea can also import iirc.

[sst...@redhat.com]

It looks like the Config project has a version of that as well:

https://github.com/eclipse/microprofile-config/blob/master/.editorconfig

[John D. Ament]

I would prefer to stick with .editorconfig and potentially an importable eclipse settings file, as long as the settings all are importable to IDEA.  Somewhere that we can define standard file headers would be super useful.

[sst...@redhat.com]

Why don't we create a microprofile-conventions repo were we can have canonical examples of everything, including the various file types license headers, editor configs, etc.

[Heiko Rupp]

Sounds like a good idea. That could even be used as a "template" for all new repos afterwards.