Skip to content

Commit 152accd

Browse files
authored
docs: add bug fixing guideline to documentation
Added a guideline for fixing bugs by creating tests before implementation.
1 parent 0da14da commit 152accd

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,8 @@ For project-specific instructions, refer to the `docs/spec.md` file in the repos
3232
- Ensure that all documentation files are updated with any code changes
3333
- Ensure that all documentation files are consistent with each, do not contradict each other and do not contain outdated information
3434
- When writing documentation, ensure that it is clear, concise, and easy to understand
35-
- Ensure that the implementation and the documentation are aligned with each other
35+
- Ensure that the implementation and the documentation are aligned with each other
36+
37+
## Fixing Bugs
38+
- Before you fix a bug, you always must first create at least one test that catches the incorrect behavior. Do not start fixing the bug before you were able to detect the bug with a test.
39+

0 commit comments

Comments
 (0)