Skip to content

Commit db813e9

Browse files
authored
Improve the new hastily-merged PR template (#882)
## Description ### Summary <!--Brief description of what this PR does.--> <!--Don't explain the code, justify what this PR exists for!--> The current template was merged too hastily by young people. I don't like its forced length, it lacks some useful points I always use like inline comments, and does not emphasize enough the duality between the short, prose-written summary and the changes made as a bullet list or check list. <!--Sources/references at the end--> ### Issues to be resolved <!-- If applicable--> <!--Use keywords "closes", "fixes", "resolves", or others at https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests --> <!--Fixes #--> <!--Fixes aeecleclair/CalypSSO#--> ### Required PRs <!-- If applicable--> <!--Use keywords "depends on" or "blocked by", see https://github.com/gregsdennis/dependencies-action --> <!--Depends on #--> <!--Depends on aeecleclair/CalypSSO#--> ### Changes Made <!--Please describe the changes made in this pull request--> <!--Tell the big steps, use a checklist to show progress. You can explain here how the code works.--> - [x] Two sections Description (text, actual checklist) and a Classification, which is collapsible to keep the page not too long - [x] Better `<!--HTML comments-->` - [x] Description: clearly explain the diff summary/changes, and use the order Summary (for its importance) -> relationships with issues and PRs (for the smallness of the subsection) -> actual changes in the code - [x] Classification: minor but useful enhancements - [x] Removed the useless end, moved up the Additional notes ### Additional Notes <!--Anything relevant that does not quite fit in the summary--> Enhances #856 as intended. <details> <summary> ## Classification </summary> ### Type of Change - [ ] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (non-breaking change which adds functionality) - [ ] 🔨 Refactor (non-breaking change that neither fixes a bug nor adds a feature) - [ ] 🔧 Infra CI/CD (changes to configs of workflows) - [ ] 💥 BREAKING CHANGE (fix or feature that require a new minimal version of the front-end) - [x] 😶‍🌫️ No impact for the end-users ### Impact & Scope - [ ] Core functionality changes - [ ] Single module changes - [ ] Multiple modules changes - [ ] Database migrations required - [x] Other: PR description template <!--not module-oriented--> ### Testing - [x] 1. Tested this locally: renders well - [x] 2. "Added/modified tests that pass the CI": it renders well on GitHub as well - [ ] 3. Tested in a pre-prod - [ ] 0. Untestable (exceptionally), will be tested in prod directly ### Documentation - [ ] Updated [the docs](docs.myecl.fr) accordingly : <!--[Docs#0 - Title](https://github.com/aeecleclair/myecl-documentation/pull/0)--> - [ ] `"` Docstrings - [ ] `#` Inline comments - [x] No documentation needed: this *is* its self-documentation </details>
1 parent d7de4da commit db813e9

File tree

2 files changed

+68
-22
lines changed

2 files changed

+68
-22
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,52 +3,78 @@
33
### Summary
44

55
<!--Brief description of what this PR does.-->
6+
<!--Don't explain the code, justify what this PR exists for!-->
67

7-
### Related Issues
8+
<!--Sources/references at the end-->
89

9-
<!-- If applicable -->
10-
Closes #<!--0-->
10+
### Issues to be resolved
1111

12-
## Changes Made
12+
<!-- If applicable-->
13+
<!--Use keywords "closes", "fixes", "resolves", or others at https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests -->
14+
15+
<!--Fixes #-->
16+
<!--Fixes aeecleclair/CalypSSO#-->
17+
18+
### Required PRs
19+
20+
<!-- If applicable-->
21+
<!--Use keywords "depends on" or "blocked by", see https://github.com/gregsdennis/dependencies-action -->
22+
23+
<!--Depends on #-->
24+
<!--Depends on aeecleclair/CalypSSO#-->
25+
26+
### Changes Made
1327

1428
<!--Please describe the changes made in this pull request-->
29+
<!--Tell the big steps, use a checklist to show progress. You can explain here how the code works.-->
30+
31+
- [x] ...
32+
- [ ] ...
33+
34+
### Additional Notes
1535

16-
- ...
36+
<!--Anything relevant that does not quite fit in the summary-->
1737

18-
## Type of Change
38+
<details>
39+
<summary>
40+
41+
## Classification
42+
43+
</summary>
44+
45+
### Type of Change
1946

2047
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
2148
- [ ] ✨ New feature (non-breaking change which adds functionality)
2249
- [ ] 🔨 Refactor (non-breaking change that neither fixes a bug nor adds a feature)
2350
- [ ] 🔧 Infra CI/CD (changes to configs of workflows)
2451
- [ ] 💥 BREAKING CHANGE (fix or feature that require a new minimal version of the front-end)
2552

26-
## Impact & Scope
53+
- [ ] 😶‍🌫️ No impact for the end-users
54+
55+
### Impact & Scope
2756

2857
- [ ] Core functionality changes
2958
- [ ] Single module changes
3059
- [ ] Multiple modules changes
3160
- [ ] Database migrations required
32-
- [ ] Other
3361

34-
## Testing
62+
- [ ] Other: <!--not module-oriented-->
3563

36-
- [ ] Added/modified tests that pass the CI
37-
- [ ] Tested in a pre-prod
38-
- [ ] Tested this locally
64+
### Testing
3965

40-
## Documentation
66+
- [ ] 1. Tested this locally
67+
- [ ] 2. Added/modified tests that pass the CI
68+
- [ ] 3. Tested in a pre-prod
4169

42-
- [ ] Updated docs accordingly (docs.myecl.fr) : <!--[Docs#0 - Title](https://github.com/aeecleclair/myecl-documentation/pull/0)-->
43-
- [ ] Code includes docstrings
44-
- [ ] No documentation needed
70+
- [ ] 0. Untestable (exceptionally), will be tested in prod directly
4571

46-
## Checklist
72+
### Documentation
4773

48-
- [ ] My code follows the style guidelines of this project
49-
- [ ] I have commented my code, particularly in hard-to-understand areas
50-
- [ ] Any dependent changes have been merged and published (_Indicate the linked PR for the dependent changes_)
74+
- [ ] Updated [the docs](docs.myecl.fr) accordingly : <!--[Docs#0 - Title](https://github.com/aeecleclair/myecl-documentation/pull/0)-->
75+
- [ ] `"` Docstrings
76+
- [ ] `#` Inline comments
5177

52-
## Additional Notes
78+
- [ ] No documentation needed
5379

54-
Add any other context, screenshots, or information about the pull request here.
80+
</details>
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "PR dependencies"
2+
3+
on:
4+
pull_request:
5+
types: [opened, edited, ready_for_review, synchronize]
6+
7+
jobs:
8+
pr_dependencies:
9+
name: Check PR dependencies
10+
runs-on: ubuntu-latest
11+
permissions:
12+
issues: read
13+
pull-requests: read
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v5
17+
- name: Check PR Dependencies
18+
uses: gregsdennis/dependencies-action@main
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)