Skip to content

Commit 8cfe9b3

Browse files
minor symfony#60872 Update GitHub PR template (javiereguiluz, nicolas-grekas)
This PR was merged into the 6.4 branch. Discussion ---------- Update GitHub PR template | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT Proposed changes: * Make some instructions more concise and actionable * Emphasize that PRs without a proper description are discouraged * Add a few emojis; not for decoration, but to improve visual separation and readability Commits ------- 40bd9ab Update GitHub PR template
2 parents 2da9a7d + 40bd9ab commit 8cfe9b3

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
| Q | A
22
| ------------- | ---
3-
| Branch? | 7.4 for features / 6.4, 7.2, or 7.3 for bug fixes <!-- see below -->
3+
| Branch? | 7.4 for features / 6.4, 7.2, or 7.3 for bug fixes
44
| Bug fix? | yes/no
5-
| New feature? | yes/no <!-- please update src/**/CHANGELOG.md files -->
6-
| Deprecations? | yes/no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
7-
| Issues | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead -->
5+
| New feature? | yes/no <!-- if yes, also update src/**/CHANGELOG.md -->
6+
| Deprecations? | yes/no <!-- if yes, also update UPGRADE-*.md and src/**/CHANGELOG.md -->
7+
| Issues | Fix #... <!-- prefix each issue number with "Fix #"; no need to create an issue if none exists, explain below -->
88
| License | MIT
99

1010
<!--
11-
Replace this notice by a description of your feature/bugfix.
12-
This will help reviewers and should be a good start for the documentation.
11+
🛠️ Replace this text with a concise explanation of your change:
12+
- What it does and why it's needed
13+
- A simple example of how it works (include PHP, YAML, etc.)
14+
- If it modifies existing behavior, include a before/after comparison
1315
14-
Additionally (see https://symfony.com/releases):
15-
- Always add tests and ensure they pass.
16-
- Bug fixes must be submitted against the lowest maintained branch where they apply
17-
(lowest branches are regularly merged to upper ones so they get the fixes too).
18-
- Features and deprecations must be submitted against the latest branch.
19-
- For new features, provide some code snippets to help understand usage.
20-
- Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
21-
- Never break backward compatibility (see https://symfony.com/bc).
16+
Contributor guidelines:
17+
- ✅ Add tests and ensure they pass
18+
- 🐞 Bug fixes must target the **lowest maintained** branch where they apply
19+
https://symfony.com/releases#maintained-symfony-branches
20+
- ✨ New features and deprecations must target the **feature** branch
21+
and must add an entry to the changelog file of the patched component:
22+
https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
23+
- 🔒 Do not break backward compatibility:
24+
https://symfony.com/bc
2225
-->

0 commit comments

Comments
 (0)