Skip to content
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

Add more PULL_REQUEST_TEMPLATE instructions #48

Merged
merged 3 commits into from
Sep 26, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion PULL_REQUEST_TEMPLATE.md.template
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
<!--
Thank you for contributing to the @@h1@@ Standard! Please describe the change you are making and complete the checklist below if your change is not editorial.
If you think your PR is ready to land, please double-check that the checklist is complete before pinging.
-->

- [ ] The build is passing. <!-- You won't be able to check this until after you've sent the PR, to give Github time to run the build. -->
- [ ] At least two implementers are interested (and none opposed):
* …
* …
- [ ] [Tests](https://github.com/web-platform-tests/wpt) are written and can be reviewed and commented upon at:
* …
* … <!-- If these tests are tentative, link a PR to make them non-tentative. -->
- [ ] [Implementation bugs](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) are filed:
* Chromium: …
* Gecko: …
* WebKit: …@@extra_implementers@@
- [ ] [MDN issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed: …
- [ ] There is a clear commit message to use when squashing this PR. Either squash the commits yourself or write the commit message here:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] There is a clear commit message to use when squashing this PR. Either squash the commits yourself or write the commit message here:
- [ ] There is a [clear commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md) to use.<!-- Editing the commit message above is okay, but beware of race conditions with the PR Preview bot. -->

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the comment you've suggested: isn't it ok to edit everything in the initial comment, for example to continue filing in implementation bugs? Where's "above"? And PR-Preview will automatically rebuild after every edit, so I've never had a problem with races.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you create a PR the initial commit message is usually included above this checklist. Editing that would be fine.

If you change the top-level comment directly after you create a PR you can definitely get into a race with PR Preview where it overrides your changes. See for instance the history of OP of whatwg/fetch#1434. PR Preview overrides a change that was made and nobody noticed afterwards (until now, as I was trying to find an example).


As for what should be in the list, it's a trade off between ensuring things are in order and making it more difficult to contribute when things are in order. I guess I'd rather start out with conveying expectations in writing and then moving to a checkbox later if that's not successful.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, thanks. I've updated this PR again to try to capture that.


(See [WHATWG Working Mode: Changes](https://whatwg.org/working-mode#changes) for more details.)