Conversation
|
Good idea about reminding people about documentation :-) Ideally, it would also be be good to have people summarise the current status of the pull request if there's a lot of discussion or amends on it. For example, this IPv6 PR looks great, until you scroll though about 40 comments to see this #1017 (comment) |
|
Yes ;-). There are multiple PRs like that. |
|
Do you want to add to the checklist the semiauto changelog entry that was suggested ? |
|
Sorry, I didn’t quite get what you mean. The checklist is to make reviewing easier and to have a certain quality standard as soon as possible. The automatic change log script might get the content from the mentioned entry. Sure. |
|
I mean to set a reminder in the template to not forget to include the line for the changelog entry, maybe as one of the things mentioned in the checklist. |
|
Changed the headline to bold style (this makes them less prominent) |
hoffie
left a comment
hoffie
left a comment
There was a problem hiding this comment.
Thanks, looks good to me! Posted some suggestions and I think this is something which can be further improved on after we have observed for some time how it works in practice.
(I think I've tried adding a PR template and failed for some reason, not sure why)
| - [ ] I verified that this Pull Request follows the [general code principles](https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md#jamulus-projectsource-code-general-principles) | ||
| - [ ] I tested my code and it does what I want | ||
| - [ ] My code follows the [style guide](https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md#source-code-consistency) <!-- You can also check if your code passes clang-format --> | ||
| - [ ] I waited some time after this Pull Request was opened and all GitHub checks completed without errors. <!-- GitHub doesn't run these checks for new contributors automatically. --> |
There was a problem hiding this comment.
| - [ ] I waited some time after this Pull Request was opened and all GitHub checks completed without errors. <!-- GitHub doesn't run these checks for new contributors automatically. --> | |
| - [ ] I've waited some time after this Pull Request was opened and all GitHub checks completed without errors. <!-- GitHub doesn't run these checks for new contributors automatically. If nobody main developer has approved the checks after a few days, feel free to post a quick ping. --> |
There was a problem hiding this comment.
If nobody main developer has approved the checks after a few days, feel free to post a quick ping
This might add pressure. Pinging should not be too common in my opinion.
Co-authored-by: Christian Hoffmann <mail@hoffmann-christian.info>
Co-authored-by: Christian Hoffmann <mail@hoffmann-christian.info>
Co-authored-by: Christian Hoffmann <mail@hoffmann-christian.info>
Co-authored-by: Christian Hoffmann <mail@hoffmann-christian.info>
| - [ ] I tested my code and it does what I want | ||
| - [ ] My code follows the [style guide](https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md#source-code-consistency) <!-- You can also check if your code passes clang-format --> | ||
| - [ ] I waited some time after this Pull Request was opened and all GitHub checks completed without errors. <!-- GitHub doesn't run these checks for new contributors automatically. --> | ||
| - [ ] I've filled all the content above |
There was a problem hiding this comment.
@dcorson-ticino-com would this wording be ok?
|
@gilgongo sorry for the ping here. Could you please also have a look at this? I think we should merge this PR soon. |
gilgongo
left a comment
gilgongo
left a comment
There was a problem hiding this comment.
Seems good to me - we can always modify it if things need changing.
5 participants
Short description of changes
Added a pull request template to make contribution and maintenance easier.
Context: Fixes an issue?
This might make categorizing Pull Requests easier and help contributors and maintainers to grasp the state of a Pull Request faster.
Does this change need documentation? What needs to be documented and how?
No.
Status of this pull request
Waiting on second approval
What is missing until this pull request can be merged?
One missing approval of the content of the Template.
Squash and merge
Checklist