Skip to Content.
Sympa Menu

devel - [sympa-developpers] Coding style guidelines

Subject: Developers of Sympa

List archive

Chronological Thread  
  • From: Luc Didry <address@concealed>
  • To: address@concealed
  • Subject: [sympa-developpers] Coding style guidelines
  • Date: Wed, 23 May 2018 10:10:07 +0200

Hello,

I created an issue on Github about coding style guidelines
(https://github.com/sympa-community/sympa/issues/319).
Please, keep the discussion about the coding style here, on the ML,
the issue is to remind us to do it.

In order to ease reading code, it's good to ensure that the coding
style is always the same (well, as much as possible)

Right now, we have minimal vim modelines (thx to Soji):
- indent with 4 spaces, no tabs

But there is a lot of other coding style stuff that could (should) be
discussed, in order to have a coherent coding style in all codebase, like:
- max line width
- to put brace on the same line than the `if` (`while`, `for`, etc)
- etc

After choosing the coding style, we can create a .perltidyrc file, and
add a test on the continuous integration to ensure style consistency.

First thing: do we agree about the 4 spaces and no tabs? (I do)

After that, we need to check the formatting options from
https://metacpan.org/pod/distribution/Perl-Tidy/bin/perltidy#FORMATTING-OPTIONS,
propose some and discuss about it.

Waiting for your feedback!
--
Luc
"La route est longue, mais la voie est libre…" https://framasoft.org

Framasoft ne vit que par vos dons (déductibles des impôts). Merci d'avance
pour votre soutien https://soutenir.framasoft.org





Archive powered by MHonArc 2.6.19+.

Top of Page