-
Notifications
You must be signed in to change notification settings - Fork 11
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
Updating PR template #161
Updating PR template #161
Conversation
.github/pull_request_template.md
Outdated
- Upgraded ... | ||
- Pipeline validation ... | ||
- Documented ... | ||
- Example ... | ||
- Script ... |
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.
I think you are missing other descriptions such as bug-fix, or feature. Would be a good idea to provide an example of a PR in every case. Also, you can point out to the different labels that are available, perhaps we should review the labels as well.
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.
I think that is contemplated at the upper line Fixes #
For me the -
are points that the one writing the PR description should fill in. So this template is a guide/reminder of which points should be written. Not meaning that all of them should be filled.
Making it too long could be counter-productive.
About the labels, perhaps this could be defined at the contribution guide, then we review the labels on GitHub.
If you agree, could we approve this PR? If not, please, propose a change through a direct commit into this PR. |
No, if the PR size is lower than 100, the PR size badge will show green, above 100 orange, and above 200 red. |
This is a simple PR to update the PR message template that appears when creating a new PR.
Feel free to suggest changes now, the PR template is a relevant communication channel!
On the other hand, I believe we should generate a new version framework release once each PR has been approved.
2.3.10 --> X.Y.Z
X: Major change. For example, Migrating from ROOT6 to ROOT7. or from RML to YML.
Y: Official data will start to be produced. To define a point in time where a experiment/project started to take physics data.
Z: Any PR increases this number.
Changing version is basically based on 3 steps:
@rest-for-physics/core_dev