- New Agent
- New Prompt Template
- Agent/Prompt Enhancement
- Documentation Update
- Bug Fix
- Configuration/Setup Change
- Other: _________
path/to/file.md- Description of changespath/to/another.md- Description of changes
Agent/Prompt Name: example-name.agent.md
Purpose: Brief description of what this agent/prompt accomplishes
Triggers: How users invoke this (e.g., @agent-name, /command)
Dependencies: Required tools, permissions, or setup
- Tested with GitHub Copilot
- Verified prompt variables work correctly
- Checked integration with existing agents
- Tested edge cases and error scenarios
- Validated against preferences.md configuration
- Scenario 1: Description and outcome
- Scenario 2: Description and outcome
- Error Handling: How it handles invalid inputs or missing data
@agent-name do something with input
Expected Output:
[Description of what the agent would respond with]
- Updated README.md if needed
- Added/updated relevant documentation
- Included usage examples
- Updated CONTRIBUTING.md if new patterns introduced
-
Code Quality
- Follows existing patterns and conventions
- YAML frontmatter is properly formatted
- Markdown formatting is consistent
- Variable placeholders use
${input:name:description}format
-
Functionality
- Agent/prompt serves a clear, useful purpose
- Integrates well with existing workflow
- Handles errors gracefully
- Respects user preferences where applicable
-
Documentation
- Clear description and usage instructions
- Examples are helpful and accurate
- Any setup requirements are documented
Closes #123
Relates to #456
For Reviewers:
- Functionality works as described
- Code follows project conventions
- Documentation is clear and complete
- Testing is adequate
- Integration considerations addressed