Ten dokument definiuje canonical terminy domenowe używane w kodzie, nazwach klas, nazwach pól i dokumentacji.
| Pojęcie | Canonical forma | Niedozwolone synonimy / aliasy |
|---|---|---|
| Grand Prix | grand_prix |
grandprix, grand-prix |
| Wielka liczba mnoga Grand Prix | grands_prix |
grandprixes, grand_prixes |
| Konstruktor F1 | constructor |
team (w nazwach pól/klas domenowych) |
| Sezon F1 | season |
championship_year |
- Dla pojęć z tabeli powyżej używamy wyłącznie form canonical.
- W Pythonie:
- pola/zmienne:
snake_case(np.grand_prix_name), - klasy:
PascalCasebazujące na canonical termach (np.GrandPrixParser, nieGrandprixParser).
- pola/zmienne:
- Jeżeli domenowo potrzebny jest termin biznesowy różny od canonical, należy:
- opisać to w PR,
- dodać wyjątek do skryptu CI
scripts/ci/check_terminology_consistency.py.
Spójność terminologiczna jest sprawdzana przez:
scripts/ci/check_terminology_consistency.py
Skrypt analizuje zmienione pliki i wykrywa użycie zabronionych synonimów.