Skip to content

Formatting guidelines / rules #31

@mal-tee

Description

@mal-tee

This is for after our launch, so low prio atm.!

Speaking from experience, maintaining open source projects with contributions from the outside can become tedious when people use different editors presets and you have huge git diffs full of white space changes and other noise.

I propose we decide on some formatting rules for source code and enforce them via tools like prettier and .editorconfig.
We'd probably have to do one nasty re-formatting commit after deciding on tools, but after that we should get clean commit diffs. :)

  • editor config: line endings, etc.
  • language specific formatting rules
    • Python
    • Docker?
  • for the patterns:
    • JSON
    • PHP
    • Python
    • Java
    • JS

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions