]> Piment Noir Git Repositories - freqai-strategies.git/commitdiff
chore: refine github copilot instructions
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Tue, 7 Oct 2025 14:44:44 +0000 (16:44 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Tue, 7 Oct 2025 14:44:44 +0000 (16:44 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
.github/copilot-instructions.md

index 5c5e2b1e00e65b33bec08724855766c69ebb56d7..106da7461adb2dd586dc9fea3f8727b463f1178f 100644 (file)
@@ -12,7 +12,7 @@ These instructions guide GitHub Copilot to generate changes consistent with this
 - **Before coding**:
   - Perform a comprehensive inventory of the codebase. Search for and read:
     - README.md, CONTRIBUTING.md, and all other documentation files.
-    - relevant code files related to the task.
+    - code files related to the task.
   - Identify existing code architecture, design patterns, canonical defaults, naming patterns and coding styles.
 - **When coding**:
   - Follow the core principles below.
@@ -22,15 +22,15 @@ These instructions guide GitHub Copilot to generate changes consistent with this
   - Ensure changes pass quality gates below.
 - **When adding a tunable**:
   - Add to canonical defaults with safe value.
-  - Ensure options and configuration section below is respected.
+  - Ensure the options and configuration section below is respected.
   - Update documentation and serialization.
-- **When implementing synthetic data generation**:
-  - Ensure simulation and synthetic data generation section below is respected.
+- **When implementing simulation or synthetic data generation**:
+  - Ensure the simulation and synthetic data generation section below is respected.
 - **When implementing analytical methods**:
   - Follow statistical conventions below.
 - **When refactoring**:
   - Keep APIs stable; provide aliases if renaming.
-  - Update code, tests, and documentations atomically.
+  - Update code, tests, and documentation atomically.
 - **When documenting**:
   - Follow documentation conventions below.