diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4ab69ebe6d..14d3899fc1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,24 @@ -### What does it do? +As part of the Docs Contribution Program, all external contribution PRs are labeled `contribution`. +Feel free to read more details on the Contribution Program in the dedicated guide: +https://strapi.notion.site/Documentation-Contribution-Program-1d08f359807480d480fdde68bb7a5a71 -Describe the technical changes you did. +Let us know if you do not wish to take part in the Docs Contribution Program, and remove the `contribution` label. +--> -### Why is it needed? +### Description -Describe the issue you are solving. +Describe the changes you did: What does it do? Why is it needed? ### Related issue(s)/PR(s) -Let us know if this is related to any issue/pull request +Let us know if this is related to any issue/pull request or contribution idea suggested by the Docs team. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 878d935e77..ec57212ff6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,8 @@ Contributing to the Strapi documentation implies 2 steps: 2. [Submit a pull request](#-pull-requests) for review. +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. + ## 🦖 Docusaurus 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: 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. 🚀 +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. ## Review and management of pull requests