com-pas / contributing

Contributing guide, code of conduct and more.
12 stars 8 forks source link

OpenSSF Best Practices Badges - Enforce coding style(s) #48

Open FredFousPro opened 2 years ago

FredFousPro commented 2 years ago

In order to fully validate the silver level of OpenSSF Best Practices Badges for our project, we have to investigate on the requirement above and see how to meet it.

Here is the requirement to meet: The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced] This MAY be implemented using static analysis tool(s) and/or by forcing the code through code reformatters. In many cases the tool configuration is included in the project's repository (since different projects may choose different configurations). Projects MAY allow style exceptions (and typically will); where exceptions occur, they MUST be rare and documented in the code at their locations, so that these exceptions can be reviewed and so that tools can automatically handle them in the future. Examples of such tools include ESLint (JavaScript), Rubocop (Ruby), and devtools check (R).

Here is the questionnaire : https://bestpractices.coreinfrastructure.org/en/projects/5925?criteria_level=1

Sander3003 commented 1 year ago

Todo:

Background: ESlint is already in place for the front-end. Sonarcloud already checks the code style with best practices