diff options
| author | kj_sh604 | 2026-05-30 00:57:46 -0400 |
|---|---|---|
| committer | kj_sh604 | 2026-05-30 00:57:46 -0400 |
| commit | da2064bbd5e2c56a81a63e6a7eb797bc91527e71 (patch) | |
| tree | 9c5e3d41b4d21d762350ad2d100293baddb36921 | |
| parent | 79335df9dcdd7e7374263a2f40fef969a203cbed (diff) | |
refactor: update prompts
| -rw-r--r-- | copilot-instructions-offline.md | 3 | ||||
| -rw-r--r-- | copilot-instructions.md | 2 |
2 files changed, 4 insertions, 1 deletions
diff --git a/copilot-instructions-offline.md b/copilot-instructions-offline.md index 3c539e5..407d506 100644 --- a/copilot-instructions-offline.md +++ b/copilot-instructions-offline.md @@ -26,6 +26,9 @@ Code Comment Style - always lowercase in comments, no title case, no sentence case - avoid emdashes (—) and simple hyphens (-) in comments - keep comments short and purposeful; explain "why", not "what" +- comments should primarily be to help navigation with ctrl+f (and/or "/" in vim mode) and explain complex sections that +are not immediately obvious +- avoid commenting self-explanatory code because it adds clutter and reduces readability - use section-header comments to divide logical blocks: ```python # config diff --git a/copilot-instructions.md b/copilot-instructions.md index 6870413..43865f0 100644 --- a/copilot-instructions.md +++ b/copilot-instructions.md @@ -8,6 +8,6 @@ Purpose ------- You are a great senior software engineer. Adopt a programming style and judgment derived from kj_sh604 (https://github.com/kj-sh604)/(https://kj-git.com/): concise, practical, POSIX shell-first, lowercase code comments, and when iterating - focused on reasonable maintainable changes. -Please avoid using emdashes (—) and simple hyphens (-) in your code comments to maintain a consistent style. +Please avoid using emdashes (—) and simple hyphens (-) in your code comments to maintain a consistent style. Code comments should primarily be to help navigation with ctrl+f (and/or "/" in Vim Mode) and explain complex code sections that's not immediately obvious. Avoid using code comments to explain simple code sections that are self-explanatory, as this can lead to clutter and reduce readability. If this file is in .github/copilot-instructions.md within the repo, feel free to update this file with memory information as the project iterates and evolves (even if you are an agent).
\ No newline at end of file |