Guidelines¶
Every guideline of the generator, which profiles get it, and which files the rule extracted from
it loads for. A generated repository loads the rules; the guidelines explain them. Generated
by go generate ./... from the generator's registry; do not edit.
Columns per language: * all project types of the language, - none, otherwise the project types: C CLI tool, L library, S service, F React frontend, E STM32 firmware, K KiCad electronics. Source files are the source files of the profile's language.
| Guideline | C++ | Go | Java | TypeScript | KiCad | Loads for |
|---|---|---|---|---|---|---|
| api_design.md | S | S | S | - | - | specs/technical_design/APIs/**, source files |
| bash_coding.md | * | * | * | * | * | **/*.sh |
| business_process_design.md | S | S | S | - | - | source files |
| can_bus.md | E | - | - | - | - | **/*.dbc, **/can*.hpp, **/can*.cpp |
| ci_cd.md | * | * | * | * | * | .gitlab-ci.yml, **/*.gitlab-ci.yml, .github/workflows/** |
| cli_tool.md | C | C | - | - | - | source files |
| containerization.md | C,S | C,S | S | * | - | **/Dockerfile*, **/*.dockerfile, image/** |
| cpp_coding.md | * | - | - | - | - | source files |
| cpp_embedded_coding.md | E | - | - | - | - | source files |
| cpp_library_coding.md | L | - | - | - | - | source files |
| data_modeling.md | * | * | * | * | - | specs/functional_design/domain_model.md, source files |
| error_handling.md | * | * | * | * | - | source files |
| frontend_integration.md | S | S | S | - | - | source files |
| general_coding.md | * | * | * | * | - | source files |
| git.md | * | * | * | * | * | No rule |
| go_coding.md | - | * | - | - | - | source files |
| java_coding.md | - | - | * | - | - | source files |
| js_coding.md | - | - | - | * | - | source files |
| library_design.md | * | * | * | * | - | source files |
| logging.md | S | S | S | - | - | source files |
| makefile_coding.md | * | * | * | * | * | Makefile, Makefile.d/**, Makefile.local |
| monitoring.md | S | S | S | - | - | source files |
| oo_design_and_programming.md | * | * | * | * | - | source files |
| pcb_layout_design.md | - | - | - | - | * | **/*.kicad_pcb |
| performance.md | S | S | S | - | - | source files |
| refactoring.md | * | * | * | * | - | source files |
| requirements.md | * | * | * | * | * | specs/capabilities/** |
| responsive_web.md | - | - | - | * | - | **/*.css, **/*.tsx, **/*.jsx |
| schematic_design.md | - | - | - | - | * | **/*.kicad_sch |
| security.md | * | * | * | * | - | source files |
| service_design.md | S | S | S | - | - | source files |
| technical_writing.md | * | * | * | * | * | **/*.md |
| testing.md | * | * | * | * | - | test/**, **/*_test.go, src/test/**, **/*.test.ts, **/*.test.tsx |
| tool_chain.md | * | * | * | * | * | devbox.json, .gitlab-ci.yml, **/*.gitlab-ci.yml, .github/workflows/** |
| typescript_coding.md | - | - | - | * | - | source files |
| ui_architecture.md | - | - | - | * | - | source files |
| ui_design_input.md | - | - | - | * | - | source files |
| user_experience.md | C | C | - | * | - | source files |