Skip to content

Commit 515fc1d

Browse files
authored
docs: updated PR template (#576)
* updated PR template * added first prune instructions * fixing review comments * start date added * fixing review comments * edited structure
1 parent 7c566d7 commit 515fc1d

1 file changed

Lines changed: 39 additions & 12 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
<!--
2+
Please fill out the sections below so maintainers can review your PR efficiently.
3+
-->
4+
15
## Description
2-
<!-- Provide a brief description of the changes in this PR -->
6+
<!-- What does this PR do and why? A sentence or two is fine. -->
37

48
## Related Issue
59
<!-- If this PR addresses an existing issue, please link to it here -->
@@ -9,20 +13,43 @@ Fixes #(issue number)
913
<!-- Mark the appropriate option with an "x" (no spaces around the "x") -->
1014
- [ ] Bug fix (non-breaking change which fixes an issue)
1115
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Refactor (no functional change)
1217
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
13-
- [ ] This change requires a documentation update
18+
- [ ] Documentation update
19+
20+
## Testing
21+
<!-- How did you verify your changes? Which tests did you run? -->
22+
- [ ] I added or updated tests covering my changes
23+
- [ ] Existing tests pass locally (`uv run pytest -m "cpu and not slow"`)
1424

15-
## How Has This Been Tested?
16-
<!-- Describe the tests you ran to verify your changes -->
25+
For full setup and testing instructions, see the [Contributing Guide](https://docs.pruna.ai/en/stable/docs_pruna/contributions/how_to_contribute.html).
1726

1827
## Checklist
1928
<!-- Mark items with "x" (no spaces around the "x") -->
2029
- [ ] My code follows the style guidelines of this project
21-
- [ ] I have performed a self-review of my own code
22-
- [ ] I have commented my code, particularly in hard-to-understand areas
23-
- [ ] I have made corresponding changes to the documentation
24-
- [ ] I have added tests that prove my fix is effective or that my feature works
25-
- [ ] New and existing unit tests pass locally with my changes
26-
27-
## Additional Notes
28-
<!-- Add any other information about the PR here -->
30+
- [ ] I have performed a self-review of my code, especially for agent-assisted changes
31+
- [ ] I updated the documentation where necessary
32+
33+
---
34+
35+
Thanks for contributing to **Pruna**! We're excited to review your work.
36+
37+
New to contributing? Check out our [Contributing Guide](https://docs.pruna.ai/en/stable/docs_pruna/contributions/how_to_contribute.html) for everything you need to get started.
38+
39+
> **Note:** Draft PRs or PRs without a clear and detailed overview may be delayed.
40+
> Please mark your PR as **Ready for Review** and ensure the sections above are filled out.
41+
42+
---
43+
44+
## First Prune (1-year OSS anniversary)
45+
46+
**First Prune** marks one year of Pruna’s open-source work. During the initiative window, qualifying merged contributions count toward **First Prune**. You can earn credits for our **performance models** via our **API**.
47+
48+
If you’d like your contribution to count toward **First Prune**, here’s how it works:
49+
50+
- **Initiative window:** First Prune starts on **March 31**.
51+
- **Issue assignment:** For your PR to count toward First Prune, the related issue must be assigned to the contributor opening the PR. Issues are labeled with **first-prune**.
52+
- **Open for review:** Please **open your PR and mark it ready for review by April 30** (end of April).
53+
- **Review priority:** We’ll make our best effort to review quickly any PR that is open and has a review request before April 30.
54+
- **Credits:** Each qualifying merged PR earns **30 credits**. We’ll be in touch after all qualifying PRs for **First Prune** have been merged.
55+
- **To get started:** Have a look at [all models](https://www.pruna.ai/all-models). You’ll need to **sign up** on the [dashboard](https://dashboard.pruna.ai/login) before you can redeem your credits.

0 commit comments

Comments
 (0)