BlueGit

timfa filemanager

Files

filemanager / .github / copilot-instructions.md

copilot-instructions.md

copilot-instructions.md 2.6 KiB Download Raw

AI Coding Agent Instructions for Filemanager

Architecture Essentials

Technical Specifications

  • For every file and implementation, log the file and all of its classes and functions in .github/technical-reference.md
  • When functionality is modified or added, update that file.
  • Reference the file before making changes to ensure no duplicate functionality is made
  • the file serves as an index and reference for the code architecture, as well as individual classes and methods.
  • Keep it short and specific; no paragraphs of explanation, only a simple notation of a file, class or method and a one-line description of what it does, what it should be used for, and what to keep into account when using it.
  • .github/tests.md is an index of every test file and every test name inside it. Keep it up to date whenever tests are added, removed, or renamed. Reference it to understand existing coverage before deciding whether to add a new test.

Developer Workflows

Git authoring

  • When starting work on something, create a feature or fix branch
  • When concrete, complete steps are made, create a commit in that branch
  • Try to commit frequently, chunking work into individual steps
  • When all work is done, merge the branch into master, and then delete it so only master remains
  • Ensure you don't leave old branches you've made in git and that everything is merged neatly.
  • Always run the full test suite and fix any issues (including unrelated to your work) before merging to master.

Testing Expectations

  • Default rule: every new feature should receive a test that verifies it behaves as requested.
  • If a very similar test already exists, expand or adapt that test instead of creating duplicate coverage.
  • When a change affects an area that existing tests are meant to cover, update those tests so the new behavior is validated too.
  • After modifying any function or module, check tests.md for tests that exercise that code path — directly or indirectly — and verify those tests still reflect the current behavior. If they no longer do, update them before finishing.
  • When encountering existing functionality that is not covered by tests, automatically add coverage for it unless it is extremely simple; for extremely simple cases, ask the user first before skipping the test.
  • Only skip adding a test, or ask the user first, when the change is truly tiny or not behaviorally meaningful (for example: wording-only copy edits, comments, or other negligible changes).
  • Prefer reusing production helpers and real code paths in tests rather than duplicating business logic in test-only code.
Source
1# AI Coding Agent Instructions for Filemanager
2
3## Architecture Essentials
4
5### Technical Specifications
6- For every file and implementation, log the file and all of its classes and functions in `.github/technical-reference.md`
7- When functionality is modified or added, update that file.
8- Reference the file before making changes to ensure no duplicate functionality is made
9- the file serves as an index and reference for the code architecture, as well as individual classes and methods.
10- Keep it short and specific; no paragraphs of explanation, only a simple notation of a file, class or method and a one-line description of what it does, what it should be used for, and what to keep into account when using it.
11- `.github/tests.md` is an index of every test file and every test name inside it. Keep it up to date whenever tests are added, removed, or renamed. Reference it to understand existing coverage before deciding whether to add a new test.
12
13
14## Developer Workflows
15
16### Git authoring
17- When starting work on something, create a feature or fix branch
18- When concrete, complete steps are made, create a commit in that branch
19- Try to commit frequently, chunking work into individual steps
20- When all work is done, merge the branch into master, and then delete it so only master remains
21- Ensure you don't leave old branches you've made in git and that everything is merged neatly.
22- Always run the full test suite and fix any issues (including unrelated to your work) before merging to master.
23
24## Testing Expectations
25- **Default rule:** every new feature should receive a test that verifies it behaves as requested.
26- If a very similar test already exists, expand or adapt that test instead of creating duplicate coverage.
27- When a change affects an area that existing tests are meant to cover, update those tests so the new behavior is validated too.
28- After modifying any function or module, check `tests.md` for tests that exercise that code path — directly or indirectly — and verify those tests still reflect the current behavior. If they no longer do, update them before finishing.
29- When encountering existing functionality that is not covered by tests, automatically add coverage for it unless it is extremely simple; for extremely simple cases, ask the user first before skipping the test.
30- Only skip adding a test, or ask the user first, when the change is truly tiny or not behaviorally meaningful (for example: wording-only copy edits, comments, or other negligible changes).
31- Prefer reusing production helpers and real code paths in tests rather than duplicating business logic in test-only code.