Repository navigation
Naming Conventions
Priyesh Patel edited this page Oct 17, 2026
·
4 revisions
List the conventions used across the repository, or link to an established standard for each language and tool.
| Area | Convention or standard |
|---|---|
| Branches | Type prefix (feat, fix, refactor, chore), issue number and short name, separated by / and -. Example: feat/96-event-schema. Git does not allow spaces or colons in branch names |
| Python modules, packages, functions and variables | snake_case (PEP 8) |
| Python classes | PascalCase |
| Python constants | UPPER_CASE |
| Python tests |
tests/ mirrors the source tree; test names follow test_<what>_<condition>
|
| Math symbols in code | Same names as the Mathematical Foundations page where they exist (n_caught, headway, load, hold) |
| TypeScript variables and functions | camelCase |
| TypeScript components and types | PascalCase |
| Front-end files and folders | kebab-case |
| Database names | snake_case |
| Issues and pull requests | Short descriptive titles. Example: Update README, Fix bug |
Python files cannot use kebab-case, because a module name with a hyphen cannot be imported.
Reference standards:
- PEP 8 (Python): https://peps.python.org/pep-0008/
- camelCase and PascalCase: https://developer.mozilla.org/en-US/docs/Glossary/Camel_case
- snake_case: https://developer.mozilla.org/en-US/docs/Glossary/Snake_case
- kebab-case: https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case
AI acknowledgement: Python, test and branch conventions updated with Claude, reviewed and edited by Priyesh Patel.