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
[docs] Add info about contribution to docs (#6816)
* Add info about contribution to docs
* Add info about contribution to docs
* Add info about contribution to docs
* Add list of writing guidelines
* Add list of writing guidelines
* Fix grammar in contributing guide
* Small changes in contributing file
Co-authored-by: Anastasiya Ivanova (DevExpress) <[email protected]>
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+20-2
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@
11
11
-[Create a Minimal Working Example](#create-a-minimal-working-example)
12
12
-[Ask for Community Support](#ask-for-community-support)
13
13
-[Contribute Code](#contribute-code)
14
+
-[Contribute to Documentation](#contribute-to-documentation)
14
15
15
16
## The TestCafe Community
16
17
@@ -28,7 +29,7 @@ If you want to test the development version of TestCafe, or contribute code to t
28
29
29
30
#### Prerequisites
30
31
31
-
TestCafe is a [Node.js](https://nodejs.org/en/) application. It supports [all actively maintained](https://github.com/nodejs/Release#release-schedule) versions of the Node.js framework. The installation process requires the presence of the [node package manager](https://www.npmjs.com/) (npm) software utility.
32
+
TestCafe is a [Node.js](https://nodejs.org/en/) application. It supports [all actively maintained](https://github.com/nodejs/Release#release-schedule) versions of the Node.js framework. The installation process requires the [node package manager](https://www.npmjs.com/) (npm) software utility.
32
33
33
34
Run the following shell command to check if your operating system contains `node` and `npm`:
34
35
@@ -165,4 +166,21 @@ Please keep in mind that the team may **suspend or reject** pull requests. There
165
166
- Poor quality code.
166
167
- Other [development priorities](https://testcafe.io/402949/roadmap) may take precedence.
167
168
168
-
Please also note that we do not merge pull requests until the changes are documented.
169
+
We merge pull requests after the changes are documented. If you want to document a new capability, add a comment with the description to the pull request. Review our [writing guidelines](#guidelines) before you proceed.
170
+
171
+
## Contribute to Documentation
172
+
173
+
Users cannot submit documentation pull requests because TestCafe stores [documentation](https://testcafe.io/documentation) in a private repository. To notify the team of an inaccuracy in the documentation, create a [Github issue](https://github.com/DevExpress/testcafe/issues/new) with the `AREA: docs` label.
174
+
175
+
#### Guidelines
176
+
177
+
The TestCafe team adheres to a set of writing guidelines that make our documentation easy to read. Follow these rules when you submit written content:
178
+
179
+
- Avoid gerunds, passive voice, and past tense.
180
+
- Avoid double negatives.
181
+
- Avoid misleading or ambiguous words and jargon.
182
+
- Avoid vague and confusing references between pronouns and their antecedents.
183
+
- Be descriptive rather than prescriptive.
184
+
- Keep your sentences short and simple. Make sure that each sentence expresses only a single idea.
185
+
- Do not repeat the same piece of information.
186
+
- If possible, include interactive examples (codes samples, screenshots, etc.).
0 commit comments