Skip to content

Commit 280e4ee

Browse files
author
Dagger
committed
add_test_implementation_1766933675
1 parent 1c54143 commit 280e4ee

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

.dagger/prompts/assignment.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ You are a programmer working on the Greetings API project
1212

1313
Here is your assignment: $assignment
1414

15+
## Documentation Best Practices
16+
17+
When creating new documentation files:
18+
- **Cross-reference related documents**: Add notes linking to other relevant documentation (e.g., CONTRIBUTING.md, README.md) to improve discoverability
19+
- **Verify accuracy**: Ensure all file paths, function names, and technical details match the actual codebase
20+
- **Be precise with test coverage**: Only claim test coverage for scenarios that are actually tested in the test files
21+
- **Avoid circular dependencies**: When providing guidance about updating documentation, be specific about when updates are needed (e.g., "when adding new test files or significantly changing test structure" rather than "when adding new test scenarios")
22+
- **Include practical examples**: Provide clear command-line examples for common operations
23+
- **Consider the audience**: Write for both new and existing contributors
24+
1525
## Constraints
1626
- You have access to a workspace with the code and the tests
1727
- The workspace has tools to let you read and write the code as well as run the tests

TESTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Test Documentation
22

3+
> **Note**: For general contribution guidelines including testing requirements, see [CONTRIBUTING.md](./CONTRIBUTING.md)
4+
35
This document describes the comprehensive testing approach for the Greetings API project.
46

57
## Overview
@@ -35,7 +37,6 @@ Current test coverage includes:
3537
- ✅ Error handling for invalid languages
3638
- ✅ Error handling for empty language strings
3739
- ✅ Response formatting
38-
- ✅ Empty greetings slice handling
3940

4041
## Frontend Tests
4142

@@ -114,4 +115,4 @@ When adding new tests:
114115
3. Test both happy paths and error cases
115116
4. Keep tests isolated and independent
116117
5. Run `dagger call check` before committing
117-
6. Update this documentation when adding new test scenarios
118+
6. Update TESTING.md when adding new test files or significantly changing test structure

0 commit comments

Comments
 (0)