Skip to content

Commit e616d89

Browse files
authored
Enhance documentation instructions for project work
Added guidelines for documenting work and user-facing features.
1 parent b9552b1 commit e616d89

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

.github/copilot-instructions.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,10 @@ Custom xUnit attributes are sometimes used for conditional test execution:
8585
- All PRs must pass format validation
8686
- Tests must pass on all target frameworks
8787
- Follow existing patterns and conventions in the codebase
88+
89+
## Documenting Work
90+
91+
Project implemention details, design and key decisions should be documented in a top-level AGENTS.md file at the repo root.
92+
Keep this file updated whenever you make change significant changes for future reference.
93+
94+
User-facing features and APIs should be documented to highlight (not extensively, as an overview) key project features and capabilities, in the readme.md file at the repo root.

0 commit comments

Comments
 (0)