-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Include common review comments in the PR template #351
Open
BrieucF
wants to merge
7
commits into
key4hep:main
Choose a base branch
from
BrieucF:PR_template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
705feb1
Include common review comments in the PR template
BrieucF 8691a99
Fix typo in PR template
BrieucF 16c0915
Fix typo in PR template
BrieucF 1b93576
encapsulate recommendations in comment
BrieucF 04c95a4
Add a reminder to check for overlaps
BrieucF 843f0ff
Move to check boxes and add more items
BrieucF 1b13d06
Fix typo
BrieucF File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,17 @@ | ||
|
|
||
| To ease the review process, please consider the following before to open the pull request: | ||
| - [ ] the code is sufficiently well documented | ||
| - [ ] the xml file free parameters that can not be modified without additional prescriptions are well indicated | ||
| - [ ] the relevant README(s) were updated. See e.g. https://github.com/key4hep/k4geo/blob/main/detector/calorimeter/README.md or https://github.com/key4hep/k4geo/blob/main/FCCee/IDEA/compact/README.md | ||
| - [ ] the code is covered by tests. See https://github.com/key4hep/k4geo/blob/main/test/CMakeLists.txt | ||
| - [ ] the PR source branch has been rebased (`--ff-only`) to `k4geo/main` | ||
| - [ ] the PR does not contain any additions or modifications that do not belong to it | ||
| - [ ] the changes in this PR have not introduced any overlaps. You can check so with the following command: ddsim --compactFile PATH_TO_COMPACT_FILE --runType run --ui.commandsInitialize "/geometry/test/run" >> overlapDump.txt | ||
| - [ ] The release notes below contain a succinct and comprehensive description of the changes that are sufficiently self-explanatory | ||
|
|
||
| BEGINRELEASENOTES | ||
| - Thank you for writing the text to appear in the release notes. It will show up | ||
| exactly as it appears between the two bold lines | ||
| - ... | ||
|
|
||
| ENDRELEASENOTES | ||
| ENDRELEASENOTES | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.