Skip to content

[P0] CONTRIBUTING.md décrit cli.py et exige des commentaires en anglais : deux règles que le dépôt contredit #196

Description

@stephrobert

État vérifié

Deux affirmations de CONTRIBUTING.md sont fausses aujourd'hui.

1. Le point d'entrée

CONTRIBUTING.md:35  « **One CLI, one entry point.** `src/dsoxlab/cli.py` is the only entry point. »
CONTRIBUTING.md:42  « … in `cli.py` or `reporting/` »
CONTRIBUTING.md:68  « ├── cli.py            ← Typer entry point »

src/dsoxlab/cli.py n'existe plus depuis 0.1.72 : c'est un paquet de
17 modules. Un contributeur qui suit ce fichier cherche un fichier absent.

Le coût est mesurable : une analyse externe du dépôt a recommandé de découper
cli.py en groupes de commandes
, travail déjà fait depuis douze versions —
parce qu'elle a lu cette page plutôt que le code.

2. La langue des commentaires

CONTRIBUTING.md:10  « issues, pull requests, code comments and commit messages
                      are written in English so everyone can take part. »

Le code est massivement commenté en français : locking.py, doctor.py,
infra/, les tests. La règle dit donc l'inverse du dépôt, et c'est
probablement sa plus grosse incohérence de gouvernance.

Ce qu'il faut trancher

Le point 1 est un simple correctif. Le point 2 est une décision, et elle
n'appartient pas à qui corrige la page :

  • tout en anglais — cohérent si l'objectif est d'accueillir des
    contributeurs externes ; suppose de reprendre l'existant, ce qui n'est pas
    une petite affaire ;
  • anglais public, français interne — la collaboration (issues, PR, commits)
    en anglais, les commentaires et docstrings en français. Il faut alors le
    dire dans CONTRIBUTING.md.

Une troisième voie existe et mérite d'être nommée : le journal est passé à
l'anglais en 0.1.83 pour des raisons précises (il se cherche mot pour mot, se
compare entre machines). Les commentaires n'ont aucune de ces propriétés — ils
ne sortent jamais du dépôt.

Critères d'acceptation

  • Les trois mentions de cli.py décrivent le paquet cli/ et ses modules.
  • Une décision est prise sur la langue des commentaires, et CONTRIBUTING.md
    la reflète.
  • Si la règle retenue est « tout anglais », une issue de suivi chiffre la
    reprise de l'existant plutôt que de laisser la page mentir à nouveau.
  • Parité EN/FR : CONTRIBUTING.fr.md reçoit les mêmes corrections.

Relevé en confrontant au code une analyse externe du dépôt, le 2026-08-24.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions