Skip to Content.
Sympa Menu

devel - Re: [sympa-developpers] Coding style guidelines

Subject: Developers of Sympa

List archive

Chronological Thread  
  • From: IKEDA Soji <address@concealed>
  • To: Luc Didry <address@concealed>
  • Cc: address@concealed
  • Subject: Re: [sympa-developpers] Coding style guidelines
  • Date: Wed, 23 May 2018 17:54:48 +0900

Hi Luc,

On Wed, 23 May 2018 10:10:07 +0200
Luc Didry <address@concealed> wrote:

> 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

Modeline would be attributed to Guillaume Rousse.

> 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.

The .perltidyrc practically used already exists.
See doc/README.perltidy and doc/dot.perltidyrc in source.

Past discussions about this file may be found in archives.


Regards,
-- Soji


> 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
>
>


--
株式会社 コンバージョン
ITソリューション部 システムソリューション1グループ 池田荘児
〒140-0014 東京都品川区大井1-49-15 アクセス大井町ビル4F
e-mail address@concealed TEL 03-6429-2880
https://www.conversion.co.jp/



Archive powered by MHonArc 2.6.19+.

Top of Page