Skip to content

Commit 668c36f

Browse files
authored
Add checkboxes to the PR template (#34919)
to require a linked issue and screenshots (and one for not force pushing). Also a few clarity improvements to the contributing guide.
1 parent 05ff886 commit 668c36f

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
<!-- Thanks for submitting a PR! Please ensure the following requirements are met in order for us to review your PR -->
1+
<!-- Thanks for submitting a PR! This checklist has the essential things that needs to be done so we can review your PR. Make sure each item is completed before checking its box. -->
22

33
## Checklist
44

55
- [ ] I have read through [review guidelines](https://github.com/element-hq/element-web/blob/develop/docs/review.md) and [CONTRIBUTING.md](https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md).
6-
- [ ] Tests written for new code (and old code if feasible).
7-
- [ ] New or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation.
8-
- [ ] Linter and other CI checks pass.
6+
- [ ] I have linked the PR to an issue that describes what needs changing.
7+
- [ ] I have written tests for new code (and old code if feasible).
8+
- [ ] I have ensured new or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation.
9+
- [ ] I have confirmed linter and other CI checks pass.
10+
- [ ] I have have included screenshots if what the user sees will change
911
- [ ] I have licensed the changes to Element by completing the [Contributor License Agreement (CLA)](https://cla-assistant.io/element-hq/element-web)
12+
- [ ] I will no longer force push to this branch

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Everyone is welcome to contribute code to Element Web, provided that they are wi
55
If you're contributing, or thinking about contributing, please come & chat to
66
us in our development room, [#element-dev](https://matrix.to/#/#element-dev:matrix.org).
77
This is the best place to ask questions about the code, how to work on the project
8-
or whether a change is likely to be accepted.
8+
or whether a change is likely to be accepted. Enhancement requests won't be
9+
merged without an issue where it's been decided to add that feature to the product.
910

1011
## How to contribute
1112

@@ -23,10 +24,12 @@ cows had five legs" and, "Add support for miniature horses" are examples of good
2324
titles. Don't include an issue number here: that belongs in the description.
2425
Definitely don't use the GitHub default of "Update file.ts".
2526

26-
As for your PR description, it should include these things:
27+
Your PR description needs to include these things:
2728

28-
- References to any bugs fixed by the change (in GitHub's `Fixes` notation)
29-
- Describe the why and what is changing in the PR description so it's easy for
29+
- A references to the bug(s) fixed by the change (in GitHub's `Fixes` notation).
30+
It's the issue's job to describe why a change is necessary: the issue template
31+
gives detail on what to include. All but trivial PRs require a linked issue.
32+
- A description of what is changing from the user's point of view so it's easy for
3033
onlookers and reviewers to onboard and context switch. This information is
3134
also helpful when we come back to look at this in 6 months and ask "why did
3235
we do it like that?" we have a chance of finding out.

0 commit comments

Comments
 (0)