Skip to content

Commit 8cf500d

Browse files
authored
Improve PR template (#1477)
1 parent 42b76b9 commit 8cf500d

File tree

2 files changed

+36
-19
lines changed

2 files changed

+36
-19
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,55 @@
11
<!--
2-
Thank you for opening a pull request! Please ensure you have taken a look at
3-
the contribution guidelines: https://github.com/adap/flower/blob/main/CONTRIBUTING.md
2+
Thank you for opening a pull request (PR)!
43
5-
Does the documentation need to be updated?
6-
See: https://flower.dev/docs/writing-documentation.html
4+
Contribution guidelines: https://github.com/adap/flower/blob/main/CONTRIBUTING.md
5+
-->
6+
7+
## Issue
8+
9+
### Description
10+
11+
<!--
12+
Describe the problem addressed by this PR.
713
8-
Does the changelog need to be updated?
9-
See: https://github.com/adap/flower/blob/main/doc/source/changelog.rst
14+
Example: The variable name `rnd` could be misinterpreted as an abbreviation of *random*, but it refers to the current server round.
1015
-->
1116

12-
#### Reference Issues/PRs
17+
### Related issues/PRs
1318

1419
<!--
15-
Please use keywords (e.g., Fixes) to create a link to the issues or pull requests
16-
you resolved.
20+
Link issues and/or PRs that are related to this PR.
1721
1822
Example: Fixes #123. See also #456 and #789.
1923
-->
2024

21-
#### What does this implement/fix? Explain your changes.
25+
## Proposal
26+
27+
### Explanation
2228

2329
<!--
24-
Explain why this PR is needed and what kind of changes have you done.
30+
Explain the changes and how they improve the issue described above.
2531
26-
Example: The variable `rnd` could be interpreted as an abbreviation of *random*, to improve clarity it was renamed to `server_round`.
32+
Example: The variable `rnd` was renamed to `server_round` to improve readability.
2733
-->
2834

29-
#### Any other comments?
35+
### Checklist
36+
37+
- [ ] Implement proposed change
38+
- [ ] Write tests
39+
- [ ] Update [documentation](https://flower.dev/docs/writing-documentation.html)
40+
- [ ] Update [changelog](https://github.com/adap/flower/blob/main/doc/source/changelog.rst)
41+
- [ ] Make CI checks pass
42+
- [ ] Ping maintainers on [Slack](https://flower.dev/join-slack/) (channel `#contributions`)
43+
44+
### Any other comments?
3045

3146
<!--
3247
Please be aware that it may take some time until the maintainers can review the PR.
33-
If you have an urgent request or question please use the Flower Slack channel.
34-
The Slack channel is really active and contributors respond pretty fast.
48+
Smaller PRs with good descriptions can be considered much more easily.
49+
50+
If you have an urgent request or question, please use the Flower Slack:
51+
52+
https://flower.dev/join-slack/ (channel: #contributions)
3553
36-
We value your contribution and are aware of the time you put into this PR.
37-
Therefore, thank you for your contribution.
54+
Thank you for contributing to Flower!
3855
-->

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ All contributions must and will be licensed under [Apache License, Version 2.0](
88

99
## Code of Conduct
1010

11-
Flower has adopted the [Contributer Covenant](https://www.contributor-covenant.org/) as its Code of Conduct. All community members are expected to adhere to it. Please see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
11+
Flower has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct. All community members are expected to adhere to it. Please see [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md) for details.
1212

1313
## Code Review & Acceptance Process
1414

15-
All contributions, including contributions from core project members, require code review. For now, our process is simple: Open a [Pull Request on GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) and ensure all tests pass. One of the responsible code owners will then review your contribution.
15+
All contributions, including contributions from core project members, require code review. The process is simple: Open a [Pull Request on GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) and ensure all CI checks pass. One of the responsible code owners will review your contribution.

0 commit comments

Comments
 (0)