From 496bad9483f3e5016cd8b04328808dc21a9a4872 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Wed, 29 Jul 2026 14:59:10 +0200 Subject: [PATCH] docs: streamline copilot instructions MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- .github/copilot-instructions.md | 42 +-------------------------------- 1 file changed, 1 insertion(+), 41 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 71c787f..33f1285 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -92,52 +92,12 @@ Documentation serves as an operational specification, not narrative prose. ## Quality gates -- Documented build/lint/type checks pass (where applicable). +- Documented build/format/lint/type checks pass (where applicable). - Documented tests pass (where applicable). - Documentation updated to reflect changes when necessary. - Logs use appropriate levels (error, warn, info, debug). - Pull request title and commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format. -## Examples - -### Naming coherence - -**Good** (consistent style, clear semantics): - -```python -threshold_value = 0.06 -processing_mode = "piecewise" -``` - -**Bad** (mixed styles, ambiguous): - -```python -thresholdValue = 0.06 # inconsistent case style -threshold_aim = 0.06 # synonym creates ambiguity -``` - -### Dynamic option generation - -```python -DEFAULT_PARAMS = { - "threshold_value": 0.06, - "processing_mode": "piecewise", -} - -def add_cli_options(parser): - for key, value in DEFAULT_PARAMS.items(): - parser.add_argument(f"--{key}", type=type(value), default=value) -``` - -### Statistical reporting - -```markdown -| Metric | Value | Interpretation | -| ----------- | ----- | --------------------- | -| KL(A‖B) | 0.023 | < 0.1: low divergence | -| Effect size | 0.12 | small to medium | -``` - --- By following these instructions, coding agents should propose changes that are consistent and maintainable across languages. -- 2.53.0