Skip to content

Commit f051254

Browse files
committed
docs(repo): add standardized Pull Request template
1 parent 1fa1f24 commit f051254

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# 🧩 Pull Request Template
2+
3+
Thank you for contributing to **spring-boot-openapi-generics-clients**! 🙌
4+
Please review the checklist and provide context to help maintainers review efficiently.
5+
6+
---
7+
8+
## 🎯 Summary
9+
10+
> Short description of what this PR does and *why* — one paragraph max.
11+
12+
Example:
13+
14+
> Implements the cleanup described in issue [#9](https://github.com/bsayli/spring-boot-openapi-generics-clients/issues/9), removing redundant DTOs and refining client generation.
15+
16+
---
17+
18+
## 📦 Changes
19+
20+
List key changes briefly (add/remove/modify):
21+
22+
* Added / removed / refactored modules or files
23+
* Updated docs or configuration
24+
* Improved client generation logic
25+
* Fixed envelope or schema alignment
26+
27+
---
28+
29+
## 🧠 Outcome / Impact
30+
31+
Explain the impact:
32+
33+
* Cleaner or smaller generated output
34+
* Improved readability or maintainability
35+
* Aligned server–client contract
36+
* Enhanced CI or test coverage
37+
38+
---
39+
40+
## ✅ Checklist
41+
42+
* [ ] Scope is minimal and focused
43+
* [ ] Build passes locally: `mvn -q -ntp clean verify`
44+
* [ ] Tests added/updated where appropriate
45+
* [ ] Docs updated (`README.md`, `docs/`, or `adoption guides`)
46+
* [ ] No accidental changes in generated code outside overlays
47+
* [ ] Linked issue (e.g., `Closes #9`)
48+
49+
---
50+
51+
## 🧾 Metadata
52+
53+
**Type:** `feature` / `bugfix` / `docs` / `refactor` / `chore` / `test` / `ci`
54+
**Related Issue:** (optional) `#issue-number`
55+
**Target Release:** (optional) e.g. `v0.7.3`
56+
57+
---
58+
59+
> 💡 *Tip:* Keep PR titles short but meaningful — for example:
60+
>
61+
> * `feature(client): add envelope auto-registration`
62+
> * `bugfix(server): fix schema drift on nested generics`
63+
> * `docs(repo): improve contributor setup guide`

0 commit comments

Comments
 (0)