Skip to content

Commit 14a542a

Browse files
Docs Contribution Program: updates in PR template & contribution guide (#2784)
* Update PULL_REQUEST_TEMPLATE.md to match docs process + mention Contrib Program * Update CONTRIBUTING.md to mention to Contrib Program * WIP → Draft --------- Co-authored-by: Pierre Wizla <[email protected]>
1 parent dfeae32 commit 14a542a

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
<!--
2-
Hello 👋 Thank you for submitting a pull request.
2+
Hello 👋 Thank you for submitting a pull request!
33
4-
To help us merge your PR, make sure to follow the instructions below:
4+
To help us merge your PR, make sure to follow the instructions detailed in the Contributing Guide:
5+
https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md
56
6-
- Create or update the documentation. (Should be made against the `main` branch)
7-
- Create or update the tests.
8-
- Refer to the issue you are closing in the PR description - fix #issue
9-
- Specify if the PR is in WIP (work in progress) state or ready to be merged
7+
Note that all documentation updates should be made against the `main` branch.
8+
Keep your PR in Draft mode until it's ready to be reviewed and merged.
109
11-
Please ensure you read through the Contributing Guide:
12-
https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md
13-
-->
1410
15-
### What does it do?
11+
As part of the Docs Contribution Program, all external contribution PRs are labeled `contribution`.
12+
Feel free to read more details on the Contribution Program in the dedicated guide:
13+
https://strapi.notion.site/Documentation-Contribution-Program-1d08f359807480d480fdde68bb7a5a71
1614
17-
Describe the technical changes you did.
15+
Let us know if you do not wish to take part in the Docs Contribution Program, and remove the `contribution` label.
16+
-->
1817

19-
### Why is it needed?
18+
### Description
2019

21-
Describe the issue you are solving.
20+
Describe the changes you did: What does it do? Why is it needed?
2221

2322
### Related issue(s)/PR(s)
2423

25-
Let us know if this is related to any issue/pull request
24+
Let us know if this is related to any issue/pull request or contribution idea suggested by the Docs team.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Contributing to the Strapi documentation implies 2 steps:
1717

1818
2. [Submit a pull request](#-pull-requests) for review.
1919

20+
By default, all external contributions are automatically labeled `contribution` to be apart of the [Docs Contribution Program](https://strapi.notion.site/Documentation-Contribution-Program-1d08f359807480d480fdde68bb7a5a71), which rewards contributors with points (based on the amount of updates in the pull request) that can then be used in the Strapi Shop to get Strapi goodies. If you do not wish to take part in the program, let the Strapi Documentation team know and the `contribution` label will be removed from your pull request.
21+
2022
## 🦖 Docusaurus
2123

2224
Strapi’s documentation is built with the React- and Markdown-based [Docusaurus](https://docusaurus.io) framework.
@@ -98,6 +100,7 @@ To submit your contribution for review:
98100

99101
That’s it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Strapi Documentation team will merge it, and the content will be live on [docs.strapi.io](http://docs.strapi.io) a few minutes later. 🚀
100102

103+
If your contribution takes part in the [Docs Contribution Program](https://strapi.notion.site/Documentation-Contribution-Program-1d08f359807480d480fdde68bb7a5a71), as soon as your pull request is merged, you should receive an email with a link to the Strapi Shop where points you have earned will have been granted to your account.
101104

102105
## Review and management of pull requests
103106

0 commit comments

Comments
 (0)