Skip to content

docs: add red-green TDD workflow guidance to Copilot instructions #4722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tpowell-progress wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add red-green TDD workflow guidance to Copilot instructions #4722

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,3 +218,13 @@ When documenting UI elements, follow these guidelines:
- **Conceptual docs** — architecture overviews, explanations, mental models
- **Release notes** — changes per version, grouped by type
- **READMEs** — project and repository overviews

## Red-Green Test-Driven Development

When making code changes in this repository, follow a red-green TDD workflow:

1. **Red**: Write or update a test that captures the desired behavior or reproduces the bug. Run the test (locally or let CI run it) and confirm it **fails**.
2. **Green**: Write the minimal code change needed to make the failing test pass. Re-run the test (locally or in CI) and confirm it now **passes**.
3. **Refactor**: With the passing test as a safety net, clean up the implementation as needed, re-running tests to ensure they remain green.

Do not write the fix before the failing test exists. This ensures every change is backed by a test that would have caught the issue, and that the fix is verifiably correct.
Loading