|
1 | 1 | # Pull Request Guidelines |
| 2 | + |
2 | 3 | ### This is a template, modify before submitting your PR |
3 | 4 |
|
4 | 5 | Please ensure that your PR title follows this format: |
5 | | -- `[Minecraft Version] [Mod loader] Feat, Fix, Ref, Docs, ..., : Description` |
| 6 | +- `[Minecraft Version] <Mod loader> Feat, Fix, Ref, Docs, ..., : Description` |
6 | 7 |
|
7 | 8 | **Examples:** |
8 | | -- `[1.20.x] [Forge] Feat: Add new block types` |
9 | | -- `[1.19.x] [All] Fix: Crash on startup` |
10 | | -- `[1.20.x] [Fabric] Refactor: Optimize rendering engine` |
| 9 | +- `[1.20.4] Feat: Add new block types` |
| 10 | +- `[1.21.4] [All] Fix: Crash on startup` |
| 11 | +- `[1.21.3] [Forge] Fix: GUI does not render` |
| 12 | +- `[1.20.1] Ref: Optimize rendering engine` |
11 | 13 |
|
12 | | -# Issue Link |
13 | | -Please create an issue if there are none applicable before submitting this pull request. |
| 14 | +### Issue Link |
| 15 | +If your PR addresses one or more issues, be sure to link them. Use appropriate keywords like `closes`, `fixes`, or `resolves` to automatically close the linked issues when the PR is merged. |
14 | 16 |
|
15 | | -Then link the issue as follows:`Closes #123` |
| 17 | +#### **Examples:** |
| 18 | +- `This PR fixes a memory leak in foo() and closes #4. It also resolves #5, which is a duplicate issue.` |
| 19 | +- `Closes #1, resolves #2, and fixes #3` |
| 20 | +- `Fixes #1` |
16 | 21 |
|
17 | | -# Description |
| 22 | +### Description |
| 23 | +Provide a concise yet detailed summary of the changes introduced in this PR. Include the purpose of the changes and any relevant context. |
18 | 24 |
|
19 | | -Provide a brief description of the changes made in this PR: |
| 25 | +#### **Examples:** |
| 26 | +- `This pull request improves compatibility with version 1.21.4 by addressing rendering issues and adding support for new block types.` |
| 27 | +- `Refactors the rendering engine to enhance performance and reduce memory usage.` |
| 28 | +- `Adds a new feature for biome-specific block spawning to align with gameplay mechanics introduced in version 1.20.4.` |
20 | 29 |
|
21 | | -- **What does this PR do?** |
22 | | -- **Why is this change needed?** |
| 30 | +### Checklist Before Submitting |
| 31 | +To ensure the quality and maintainability of your PR, confirm the following before submission: |
| 32 | +1. Code adheres to the project's style guide and conventions. |
| 33 | +2. All tests pass, including newly added tests. |
| 34 | +3. Documentation has been updated to reflect any new features or changes. |
| 35 | +4. Your PR is limited to a single purpose, avoiding unrelated changes. |
0 commit comments