Skip to content

Commit 6426808

Browse files
committed
Add PR template
1 parent 1a5b3a8 commit 6426808

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.github/pull_request_template.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Description
2+
Briefly explain the "why" and "what" of this PR.
3+
4+
## Type of Change
5+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
6+
- [ ] ✨ New feature (non-breaking change which adds functionality)
7+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] ♻️ Refactoring (no functional changes, no API changes)
9+
- [ ] ⚙️ Infrastructure / Configuration / CI/CD update
10+
- [ ] 📚 Documentation update
11+
12+
## Code Quality & Style
13+
- [ ] My code follows the project's established style guidelines and linters pass.
14+
- [ ] I have performed a self-review of my own code before requesting a review.
15+
- [ ] Code is clear, readable, and properly commented (especially in complex logic or edge cases).
16+
- [ ] Variable/function/class names are descriptive and follow naming conventions.
17+
- [ ] No sensitive data (secrets, API keys, passwords) are hardcoded or accidentally committed.
18+
19+
## Testing
20+
- [ ] I have added new unit tests that prove my fix is effective or my feature works.
21+
- [ ] Existing unit and integration tests pass locally with my changes.
22+
- [ ] I have tested edge cases and failure modes (e.g., nil pointers, network timeouts).
23+
24+
## Architecture, Performance & Safety
25+
- [ ] Changes handle concurrency safely (e.g., no race conditions, safe channel/thread usage).
26+
- [ ] Resource management is handled properly (e.g., closing connections, no goroutine/memory leaks).
27+
- [ ] Database queries are optimized (e.g., proper indexing, avoiding N+1 query problems).
28+
- [ ] Any necessary database schema migrations are included and tested.
29+
30+
## Deployment & Infrastructure
31+
- [ ] Necessary updates to infrastructure manifests (e.g., Kubernetes YAMLs, Helm charts) are included.
32+
- [ ] Environment variables or configuration changes required for deployment have been documented.
33+
- [ ] I have verified that monitoring, logging, or alerting is in place for new critical pathways.

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,6 @@ Always treat these as quality gates for substantial changes:
8989
- `./scripts/setup-local-postgres.sh`
9090
- `./scripts/cleanup-local-postgres.sh`
9191
- `scripts/ensure-local-postgres.mjs` is used by `predev` and `prestart` to fail fast when the configured local PostgreSQL instance is not reachable.
92+
93+
## Pull Request
94+
After completing your changes, create a pull request with a clear description of the "why" and "what". Use the [provided PR template](.github/pull_request_template.md) to ensure all relevant information is included for reviewers. And, use `gh` to create the PR.

0 commit comments

Comments
 (0)