You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+38-53Lines changed: 38 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,47 +6,44 @@ All efforts to contribute are highly appreciated, we recommend you talk to a mai
6
6
7
7
## Open Development & Community Driven
8
8
9
-
Strapi is an open-source project. See the [LICENSE](https://github.com/strapi/documentation/blob/main/LICENSE) file for licensing information. All the work done is available on GitHub.
9
+
Strapi is an open-source project. See the [LICENSE](https://github.com/strapi/documentation/blob/main/LICENSE) file for licensing information. All of the work is available on GitHub.
10
10
11
11
The core team and the contributors send pull requests which go through the same validation process.
12
12
13
-
## Documentation Requests
13
+
## Code of Conduct
14
14
15
-
Requests for new documentation are highly encouraged, this is not limited to new additions but also changes or more information requested on existing documentation. Please use our [request documentation](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template.
15
+
This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold the code.
16
16
17
-
## Code of Conduct
17
+
## Documentation Requests
18
18
19
-
This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please read the [full text](CODE_OF_CONDUCT.md) so that you can read which actions may or may not be tolerated.
19
+
Requests for new documentation are highly encouraged, this is not limited to new additions but also changes or more information requested on existing documentation. Please use our [request documentation](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template. If you are requesting documentation, please feel free to open a pull request.
20
20
21
21
## Bugs
22
22
23
-
We are using [GitHub Issues](https://github.com/strapi/documentation/issues)to manage our public bugs. Before submitting an issue you need to make sure:
23
+
Bug reports help to improve the documentation. Please use our [Documentation Bug Report](https://github.com/strapi/documentation/issues/new?template=BUG_REPORT.yml) template to report documentation bugs. Before submitting an issue:
24
24
25
-
- Checked for any existing pull requests that may address the same issue
26
-
- Checked for any open issues related to your issue, if so, please provide context on that issue
27
-
- Follow the issue template and try to fill out as much information as you can
28
-
- Issues not following the templates **will be closed**
29
-
- You may update the closed issue with the required information and it will be reopened
30
-
- The issue is with the Strapi **documentation only**, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repo issues
31
-
- If you are requesting documentation, please do feel free to make a pull request
32
-
- Documentation requests will be handled when we have free room within our roadmap
33
-
- Open requests **are not handled** in a "first come, first serve" basis, they are handled on a "best-effort" depending on the time required to produce
34
-
- Do not ask technical questions about how to do something
35
-
- Questions should be directed at the following resources
36
-
- Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
37
-
- Talk with other community members on our [Community Discord](https://discord.strapi.io)
25
+
- Check for existing pull requests that may address the same issue.
26
+
- Check for related open issues, if so, please provide context on the existing issue.
27
+
- Follow the issue template and fill out as much information as you can.
28
+
- Verify the issue is only with the Strapi documentation, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repository.
29
+
30
+
Technical questions should be asked using the following resources:
38
31
39
-
Please note that rude or impolite comments on issues that violate our [Code of Conduct](./CODE_OF_CONDUCT.md) will be deleted and issues that violate the COC will be closed.
32
+
- Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
33
+
- Engage with other community members on our [Community Discord](https://discord.strapi.io)
40
34
41
35
---
42
36
43
-
## Submitting a Pull Request
37
+
## Pull Requests
44
38
45
-
The core team will review your pull request and will either merge it, request changes to it, or close it.
39
+
The core team reviews community pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:
46
40
47
-
### Setup and pull request creation
41
+
- clicking the `Improve this page` link at the bottom of any documentation page to directly edit in GitHub,
42
+
- forking the `documentation` repository and working locally.
48
43
49
-
Follow the procedure below to contribute to the Strapi documentation.
44
+
### Setup and write locally
45
+
46
+
The following procedure allows you to work locally on the Strapi documentation.
50
47
51
48
1. Fork the `documentation` repository.
52
49
2. Clone your forked `documentation` repository.
@@ -65,7 +62,7 @@ Follow the procedure below to contribute to the Strapi documentation.
65
62
cd documentation/docs/user-docs
66
63
```
67
64
68
-
4. Choose the branch from which to work: either `main`for a contribution on the latest, current version or Strapi; or `v[x]`for a contribution on a previous version of Strapi.
65
+
4. Choose the branch from which to work: either `main`for a contribution on the current version of Strapi or `v[x]`for a contribution on a previous version of Strapi.
69
66
70
67
```bash
71
68
#current version of Strapi (i.e. v4)
@@ -86,7 +83,7 @@ Follow the procedure below to contribute to the Strapi documentation.
86
83
git pull
87
84
```
88
85
89
-
6. Create your own branch, based on either `main` or `v[x]` , on which you will work on your documentation contribution. Make sure the name of your branch indicates both the type of documentation and the topic.
86
+
6. Create your branch, based on either `main` or `v[x]`, to work on your documentation contribution. Make sure your branch name indicates both the type of documentation and the topic.
90
87
91
88
```bash
92
89
# developer documentation
@@ -118,43 +115,31 @@ Follow the procedure below to contribute to the Strapi documentation.
118
115
119
116
The project is now up and running at http://localhost:8080 and you should be able to access it in your browser.
120
117
121
-
122
118
You are now ready to contribute to the Strapi documentation! 🚀
123
119
124
-
🤗 Make sure to follow the [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) and the [Strapi Documentation Style Guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) when writing your documentation contribution. These documents are meant to help you write a contribution that fits the whole Strapi documentation and make the reviewing process easier and quicker.
125
-
126
-
When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information).
120
+
### Write technical documentation
127
121
128
-
✋ To be able to submit your contribution, you must sign the CLA (Contributor License Agreement), directly via GitHub (see [our dedicated blog post](https://strapi.io/blog/switching-from-dco-to-cla) for more information).
122
+
For lengthier contributions, we provide general guidelines that can help you write clear and concise documentation:
129
123
130
-
### Pull request review and management
124
+
- The [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) gives an overview of how to structure and write clear documentation.
125
+
- The [Strapi Documentation Style Guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) has formatting guidelines and how to implement formatting in markdown files.
131
126
132
-
Read the information below to know how your contribution will be handled by the Strapi Documentation team until it is merged and deployed.
127
+
When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information) or use the _Create a new branch for this commit and start a pull request_ option if you are using the GitHub web browser interface (see [the GitHub docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
133
128
134
-
#### Handling
129
+
✋ Sign the CLA (Contributor License Agreement), directly via GitHub (see [our dedicated blog post](https://strapi.io/blog/switching-from-dco-to-cla) for more information).
135
130
136
-
When a new pull request is submitted in the Strapi `documentation` repository, it is handled in the following week, meaning that the Strapi team:
131
+
### Review and management of pull requests
137
132
138
-
- acknowledges the new pull request, leaving a 👀 reaction on the description
139
-
- tags the pull request, to indicate the type of documentation that is being updated, and optionally the level of priority for the contribution
140
-
- assigns the pull request to a member of the Strapi Documentation team, who will be in charge of the reviewing and merging
133
+
The pull request review process and timeline are based on the availability of Strapi's Documentation team to handle community contributions. The workflow is:
141
134
142
-
#### Review
135
+
1. The pull request is assigned to a member of the Documentation team.
136
+
2. At least 1 member of the Documentation team will review the pull request for:
143
137
144
-
Once all of the handling steps are done by the Strapi team, you can expect your pull request to be reviewed in the next week or so.
138
+
- accuracy,
139
+
- quality,
140
+
- alignment with the documentation scope and roadmap.
145
141
146
-
Here is what the Strapi Documentation team will review in your pull request:
147
-
148
-
- The accuracy and coherence of the contribution, by testing any new piece of code or action for example,
149
-
- The quality of the technical writing, to make sure it is proper technical documentation that is easy to understand (see [12 Rules of Technical Writing](https://www.notion.so/12-Rules-of-Technical-Writing-c75e080e6b19432287b3dd61c2c9fa04))
150
-
- The fit of the contribution among the rest of the Strapi documentation (see [Strapi Documentation Style Guide](https://www.notion.so/Strapi-Documentation-Style-Guide-b9c21387732741ed8b0a3f9701612577))
151
-
152
-
The pull request will be validated once the contribution ticks all the boxes. At least the validation of the Strapi Documentation team member in charge of the pull request is necessary for it to be merged.
153
-
154
-
#### Deployment
155
-
156
-
Once your pull request is validated and merged, it will be deployed with the next batch of merged pull requests. The Strapi Documentation team only deploys the documentation on Wednesdays, but not every week.
142
+
3. Reviewers will either approve, ask for changes, or reject the pull request.
143
+
4. Accepted pull requests will be merged and deployed as part of the regular documentation deployments on Wednesdays every 2 weeks.
157
144
158
145
Every documentation deployment is communicated through a message in [the "News" section of the Strapi forum](https://forum.strapi.io/c/news/5).
0 commit comments