Part of #6393.
Problem
CONTRIBUTING.md does not link contributors to any authoritative coding conventions. doc/Developing.md covers building, debugging, and running tests, but not how we expect code to be written (naming, error handling, resource strings, etc.). New contributors have to infer conventions from surrounding code.
Proposed change
Add concise coding conventions guidance - either a new doc/Coding.md referenced from CONTRIBUTING.md, or a dedicated section - covering at minimum:
- Naming and formatting expectations (and a pointer to
.editorconfig).
- Error handling patterns used in the codebase (e.g.,
hr / AICLI_* result handling).
- The resource-string
<comment> requirement already documented in doc/Developing.md (Localization).
- A pointer to
.github/copilot-instructions.md for build/architecture/convention context.
Notes for engineers
The team should define/ratify the canonical conventions to document here. This issue is about creating the home for them and linking it from CONTRIBUTING.md; the specific rules need engineering input.
Acceptance criteria
- A coding conventions doc (or section) exists and is linked from
CONTRIBUTING.md.
(Created with GitHub Copilot assistance.)
Part of #6393.
Problem
CONTRIBUTING.mddoes not link contributors to any authoritative coding conventions.doc/Developing.mdcovers building, debugging, and running tests, but not how we expect code to be written (naming, error handling, resource strings, etc.). New contributors have to infer conventions from surrounding code.Proposed change
Add concise coding conventions guidance - either a new
doc/Coding.mdreferenced fromCONTRIBUTING.md, or a dedicated section - covering at minimum:.editorconfig).hr/AICLI_*result handling).<comment>requirement already documented indoc/Developing.md(Localization)..github/copilot-instructions.mdfor build/architecture/convention context.Notes for engineers
The team should define/ratify the canonical conventions to document here. This issue is about creating the home for them and linking it from
CONTRIBUTING.md; the specific rules need engineering input.Acceptance criteria
CONTRIBUTING.md.(Created with GitHub Copilot assistance.)