diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e70c2868..eb418964 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,100 +1,50 @@ -# Pull Request +## Summary -> **๐Ÿ“‹ Choose Specialized Template** -> -> We now offer specialized templates for different types of PRs to help you fill out the information faster: -> -> - ๐Ÿ”ง **[Backend PR Template](./PULL_REQUEST_TEMPLATE/backend.md)** - For Go/API/Trading changes -> - ๐ŸŽจ **[Frontend PR Template](./PULL_REQUEST_TEMPLATE/frontend.md)** - For UI/UX changes -> - ๐Ÿ“ **[Documentation PR Template](./PULL_REQUEST_TEMPLATE/docs.md)** - For documentation updates -> - ๐Ÿ“ฆ **[General PR Template](./PULL_REQUEST_TEMPLATE/general.md)** - For mixed or other changes -> -> **How to use?** -> - When creating a PR, add `?template=backend.md` or other template name to the URL -> - Or simply copy and paste the content from the corresponding template +- Problem: +- What changed: +- What did NOT change (scope boundary): ---- +## Change Type -> **๐Ÿ’ก Tip:** Recommended PR title format `type(scope): description` -> Example: `feat(trader): add new strategy` | `fix(api): resolve auth issue` +- [ ] Bug fix +- [ ] Feature +- [ ] Refactoring +- [ ] Docs +- [ ] Security fix +- [ ] Chore / infra ---- +## Scope -## ๐Ÿ“ Description +- [ ] Trading engine / strategies +- [ ] MCP / AI clients +- [ ] API / server +- [ ] Telegram bot / agent +- [ ] Web UI / frontend +- [ ] Config / deployment +- [ ] CI/CD / infra - - - ---- - -## ๐ŸŽฏ Type of Change - -- [ ] ๐Ÿ› Bug fix -- [ ] โœจ New feature -- [ ] ๐Ÿ’ฅ Breaking change -- [ ] ๐Ÿ“ Documentation update -- [ ] ๐ŸŽจ Code style update -- [ ] โ™ป๏ธ Refactoring -- [ ] โšก Performance improvement -- [ ] โœ… Test update -- [ ] ๐Ÿ”ง Build/config change -- [ ] ๐Ÿ”’ Security fix - ---- - -## ๐Ÿ”— Related Issues +## Linked Issues - Closes # -- Related to # +- Related # ---- +## Testing -## ๐Ÿ“‹ Changes Made +What you verified and how: - -- -- +- [ ] `go build ./...` passes +- [ ] `go test ./...` passes +- [ ] Manual testing done (describe below) ---- +## Security Impact -## ๐Ÿงช Testing +- Secrets/keys handling changed? (`Yes/No`) +- New/changed API endpoints? (`Yes/No`) +- User input validation affected? (`Yes/No`) -- [ ] Tested locally -- [ ] Tests pass -- [ ] Verified no existing functionality broke +## Compatibility ---- - -## โœ… Checklist - -### Code Quality -- [ ] Code follows project style -- [ ] Self-review completed -- [ ] Comments added for complex logic - -### Documentation -- [ ] Updated relevant documentation - -### Git -- [ ] Commits follow conventional format -- [ ] Rebased on latest `dev` branch -- [ ] No merge conflicts - ---- - -## ๐Ÿ“š Additional Notes - - - - ---- - -**By submitting this PR, I confirm:** - -- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md) -- [ ] I agree to the [Code of Conduct](../CODE_OF_CONDUCT.md) -- [ ] My contribution is licensed under AGPL-3.0 - ---- - -๐ŸŒŸ **Thank you for your contribution!** +- Backward compatible? (`Yes/No`) +- Config/env changes? (`Yes/No`) +- Migration needed? (`Yes/No`) +- If yes, upgrade steps: