|
1 | 1 | <!--
|
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)! |
4 | 3 |
|
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. |
7 | 13 |
|
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. |
10 | 15 | -->
|
11 | 16 |
|
12 |
| -#### Reference Issues/PRs |
| 17 | +### Related issues/PRs |
13 | 18 |
|
14 | 19 | <!--
|
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. |
17 | 21 |
|
18 | 22 | Example: Fixes #123. See also #456 and #789.
|
19 | 23 | -->
|
20 | 24 |
|
21 |
| -#### What does this implement/fix? Explain your changes. |
| 25 | +## Proposal |
| 26 | + |
| 27 | +### Explanation |
22 | 28 |
|
23 | 29 | <!--
|
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. |
25 | 31 |
|
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. |
27 | 33 | -->
|
28 | 34 |
|
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? |
30 | 45 |
|
31 | 46 | <!--
|
32 | 47 | 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) |
35 | 53 |
|
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! |
38 | 55 | -->
|
0 commit comments