-
Notifications
You must be signed in to change notification settings - Fork 28
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
Set up default owners and the pull request checklist #270
Conversation
@lukaszachy, @happz, @thrix, @janhavlin, @martinhoyer, are you ok with being included in the default list of reviewers? |
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 wonder if we could try to make the checklist "expandable". Is this how it's done?
<details>
<summary>Checklist</summary>
- [ ] Implement the feature
- [ ] Write the documentation
- [ ] Extend the test coverage
- [ ] Mention the version
- [ ] Include a release note
</details>
Oh and maybe add
## Description
<!-- Briefly describe what this PR does and why it is needed. -->
## Related Issues
<!-- List any related issues or tasks. Use keywords like "Fixes #123" to close them automatically. -->
- Fixes #
Before or after the checklist so it's at somehow standardized? I ne er know if the checklist should stay at the top or go at the bottom for example :) (would vote to have it at the bottom)
No need I have this repo on watch list
I would vote to keep it outside expandable environment because it's something that would be updated regularly and should be checked by both author and reviewer. 👍 for the sections separator |
Agree with this. The main point of the check list is to keep these important steps in sight so that we don't forget them. Hiding the checklist under collapsable section would not help with this plus additional clicks would be needed for each update. |
Let's enable the `CODEOWNERS` file so that we do not have to ask for review manually for each pull request. Also add the pull request checklist so that we don't forget about the important steps (like including the release note which was missing in all recent pulls).
b0f8c7b
to
8bfe822
Compare
I'm not sure about this. For me a more efficient workflow is to include the description in the commit details when writing the commit message. This get's automatically synced to the pull request description plus you get the checklist automatically appended (at the bottom). So, if user includes Using section separator for the checklist sounds good, added in 8bfe822. |
It depends on repo settings. It can be configured to either use the PR's title and description, or the commit messages (don't remember if only title or full message). Allowing to include the |
Yes, mentioning the fixed or releated issue is definitely a good idea. And can be done in both commit details description or later in the pull request description. We also recommend this on the |
Let's enable the
CODEOWNERS
file so that we do not have to ask for review manually for each pull request. Also add the pull request checklist so that we don't forget about the important steps (like including the release note which was missing in all recent pulls).