pull_request_template.mdโข3.72 kB
# ๐ฆ Duck Pond Pull Request
Thanks for contributing to our duck pond! Let's make sure your contribution is ready to swim with the rest of the flock.
```
__
<(o )___
( ._> / "Quack! Let's review this together!"
`---'
```
## ๐ Description
**What does this PR do?**
<!-- Briefly describe the changes in this PR -->
**Related Issue(s):**
<!-- Link related issues using keywords: "Fixes #123", "Closes #456", "Related to #789" -->
## ๐ฏ Type of Change
**What kind of change is this?** *(check all that apply)*
- [ ] ๐ **Bug fix** (non-breaking change that fixes an issue)
- [ ] โจ **New feature** (non-breaking change that adds functionality)
- [ ] ๐ฅ **Breaking change** (fix or feature that would cause existing functionality to change)
- [ ] ๐ **Documentation update** (changes to docs, README, etc.)
- [ ] ๐งน **Maintenance** (dependency updates, refactoring, etc.)
- [ ] ๐งช **Tests** (adding or updating tests)
## ๐งช How Has This Been Tested?
**Testing details:**
<!-- Describe the tests you ran and how to reproduce them -->
- [ ] **Unit tests pass:** `npm test`
- [ ] **Linting passes:** `npm run lint`
- [ ] **Build succeeds:** `npm run build`
- [ ] **Manual testing performed**
**Test Configuration:**
- **OS:** [e.g., macOS 14.0]
- **Node.js:** [e.g., 20.5.0]
- **Providers tested:** [e.g., OpenAI, local testing]
## โ
Pre-Flight Checklist
**Before submitting:** *(check all that apply)*
### Code Quality
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
### Documentation
- [ ] I have updated the documentation (README, CONTRIBUTING, etc.)
- [ ] I have updated CHANGELOG.md (if this is a notable change)
- [ ] My commit messages follow [conventional commits](./CONTRIBUTING.md#commit-messages-duck-communication-protocol)
### Dependencies & Compatibility
- [ ] I have not introduced any new dependencies without discussion
- [ ] My changes are compatible with the supported Node.js versions (20+)
- [ ] I have considered backwards compatibility
### Specific to This Project
- [ ] If adding a new provider: I've followed the provider pattern in `src/providers/`
- [ ] If modifying tools: I've updated the tool documentation
- [ ] If changing configuration: I've updated environment variable examples
- [ ] I have not broken existing provider configurations
## ๐ Semantic Release Impact
**Version impact of this PR:** *(for maintainers)*
- [ ] **Patch** release (bug fixes) - `fix:` commits
- [ ] **Minor** release (new features) - `feat:` commits
- [ ] **Major** release (breaking changes) - `BREAKING CHANGE:` in commit body
## ๐ธ Screenshots *(if applicable)*
**Visual changes:**
<!-- Add screenshots to show UI changes, new features, etc. -->
## ๐ค Additional Notes
**Anything else reviewers should know:**
<!-- Any additional information, concerns, or discussion points -->
## ๐ References
**Helpful links:**
- [Contributing Guide](./CONTRIBUTING.md)
- [Commit Message Guidelines](./CONTRIBUTING.md#commit-messages-duck-communication-protocol)
- [Code of Conduct](./CONTRIBUTING.md#duck-pond-etiquette)
---
## ๐ฆ For Reviewers
**Review focus areas:**
- [ ] Code quality and style
- [ ] Test coverage
- [ ] Documentation updates
- [ ] Breaking change considerations
- [ ] Performance impact
- [ ] Security considerations
---
*"Great PRs make great ducks! Thanks for taking the time to contribute properly. ๐ฆโจ"*