Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
<!--
Hello 👋 Thank you for submitting a pull request.
Hello 👋 Thank you for submitting a pull request!

To help us merge your PR, make sure to follow the instructions below:
To help us merge your PR, make sure to follow the instructions detailed in the Contributing Guide:
https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md

- Create or update the documentation. (Should be made against the `main` branch)
- Create or update the tests.
- Refer to the issue you are closing in the PR description - fix #issue
- Specify if the PR is in WIP (work in progress) state or ready to be merged
Note that all documentation updates should be made against the `main` branch.
Keep your PR in Draft mode until it's ready to be reviewed and merged.

Please ensure you read through the Contributing Guide:
https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md
-->

### 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.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down