Skip to content

Commit b99f1e4

Browse files
authored
Update pull_request_template.md (#2979)
* Update pull_request_template.md Signed-off-by: Kim Brose <[email protected]> * Update pull_request_template.md Signed-off-by: Kim Brose <[email protected]> * edit closer to a comment box Signed-off-by: Kim Brose <[email protected]> * update pr template based on review * add PR Bot via CI * Update time sensitivity process step description Signed-off-by: Kim Brose <[email protected]> * Tweak time sensitivity process step description more Signed-off-by: Kim Brose <[email protected]> --------- Signed-off-by: Kim Brose <[email protected]>
1 parent 7ca9977 commit b99f1e4

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,27 @@
66
77
You can use the CI build or a local environment to check your changes are working as expected.
88
9-
If you have questions at any time, please contact the Website Working Group at
9+
If you have questions at any time, please contact the Website & Content Working Group at
1010
https://matrix.to/#/#matrix.org-website:matrix.org -->
1111

12-
<!-- Please describe what you added, and add a screenshot or video if possible.
12+
### Description
13+
<!-- Please describe what you added here, and add a screenshot or video if possible.
1314
That makes it easier to understand the change. -->
1415

15-
<!-- Please don't remove this checklist from your PR, as it is useful for reviewers, too. -->
16-
**:heavy_check_mark: Checklist**
16+
### :heavy_check_mark: Checklist
17+
<!-- Please tick as appropriate, but don't remove this checklist from your PR, as it is useful for reviewers, too. -->
1718

19+
- [x] Keep this checklist
1820
- Check for common mistakes:
1921
- [ ] Wrap plain URLs in `<>` to linkify them ([learn more](https://github.com/matrix-org/matrix.org/blob/main/CONTENT.md#publishing-to-the-blog)).
2022
- [ ] Use the right level of headings: The page title will use a level 1 headings, so your headings should use level 2 and below.
2123
- [ ] Use internal links: when linking to another page on <https://matrix.org>, use the Zola `[label](@/target.md)` [syntax](https://www.getzola.org/documentation/content/linking/#internal-links).
2224
- For blog posts:
2325
- [ ] Verify the date and post ordering on the `/blog` page, especially for multiple posts on the same day. Prefer UTC format, e.g. `2025-12-01T14:00:00Z` for Dec 1st, 2025, 2pm UTC.
2426
- [ ] Set the correct author and category. Browse existing ones at <https://matrix.org/author/> and <https://matrix.org/category/> to match them.
25-
- [ ] Let us know if you are contributing in a specific role, such as on behalf of an organisation or team, [for example](https://github.com/matrix-org/matrix.org/pull/2788).
26-
- [ ] Let us know if your PR is time-sensitive in any way.
27+
- [ ] If you hold a specific role in relation to the content you are contributing, such as project maintainer or on behalf of a team or organisation, please let us know. See [example](https://github.com/matrix-org/matrix.org/pull/2969).
28+
- [ ] If your PR is time-sensitive in any way, please mention the attached timeline and context in the PR description.
2729
- [ ] Mention any issues related to the PR. Use [GitHub keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) as appropriate.
2830
- [ ] Your individual commits or pull request is [signed off](https://github.com/matrix-org/matrix.org/blob/main/CONTRIBUTING.md).
31+
32+
<!-- ------------------------------ DO NOT WRITE BELOW THIS LINE ------------------------------ -->

.github/workflows/pr-bot.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: PR Bot
2+
3+
on:
4+
pull_request:
5+
types: [opened, reopened] # https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=ready_for_review#pull_request
6+
7+
jobs:
8+
missing-template:
9+
name: Auto-draft PRs missing template
10+
runs-on: ubuntu-latest
11+
permissions: write-all
12+
env:
13+
CHECKOUT_DIR: my-repo
14+
15+
steps:
16+
- uses: actions/checkout@v5
17+
with:
18+
path: ${{ env.CHECKOUT_DIR }}
19+
20+
- name: Check if the PR template was deleted
21+
env:
22+
GH_TOKEN: ${{ github.token }}
23+
BASE_URL: ${{ github.server.url }}/${{ github.repository }}/blob/main
24+
working-directory: ${{ env.CHECKOUT_DIR }}
25+
run: |
26+
if ! gh pr view $GITHUB_HEAD_REF --json 'body' | grep -q "don't remove this checklist from your PR"; then
27+
gh pr ready $GITHUB_HEAD_REF --undo # mark as draft
28+
gh pr edit $GITHUB_HEAD_REF --add-label 'missing-template'
29+
gh pr review $GITHUB_HEAD_REF --request-changes --body "Thanks for contributing to the matrix.org website. I have automatically marked you pull request as a draft. Please restore the [PR template]($BASE_URL/.github/pull_request_template.md?plain=1) to your PR description and follow our [contributing guidelines]($BASE_URL/CONTRIBUTING.md), then undraft to let the team know the PR is ready for review."
30+
fi

0 commit comments

Comments
 (0)