Skip to content

Rules shall enforce things #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rules shall enforce things #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/en/02_devenv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ For more information about the guidelines that `rustfmt` will check, have a look
at the [Rust Style Guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).

> ### Rule {{#check DENV-FORMAT | Use Rust formatter (rustfmt)}}
> The tool `rustfmt` can be used to ensure that the codebase respects style
> The tool `rustfmt` must be used to ensure that the codebase respects style
> guidelines (as described in `rustfmt.toml` file), with `--check` option and
> manual review.

Expand Down
2 changes: 1 addition & 1 deletion src/fr/02_devenv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Pour plus d'informations à propos des règles de convention de style que

> ### Règle {{#check DENV-FORMAT | Utilisation d'un outil de formatage (rustfmt)}}
>
> L'outil de formatage `rustfmt` peut être utilisé pour assurer le respect de
> L'outil de formatage `rustfmt` doit être utilisé pour assurer le respect de
Copy link
Contributor

@hg-anssi hg-anssi Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je comprends le principe d'imposer le verbe "devoir" dans la rédaction des règles.

Par contre, pour un guide sur les bonnes pratiques de sécurité, je me pose la question d'imposer un formatage au code.

Copy link

@Ltrlg Ltrlg Jun 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L’uniformité de formatage facilite la lecture, donc peut simplifier la contribution avec relecture par pair et les audits. Mais même en tenant compte de ce fait, je m’attendrais plutôt à trouver un (double1) should qu’un must.

Footnotes

  1. Un outil de formatage devrait être utilisé ; celui-ci devrait être rustfmt. ↩

> règles de convention de style (comme décrites dans le fichier `rustfmt.toml`)
> sur une base de code, avec l'option `--check` ainsi qu'une revue de code
> manuelle.
Expand Down