Skip to content

Commit 53b1010

Browse files
committed
Improve documentation
1 parent 69fec1b commit 53b1010

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ assignees: ''
99
Thanks for reporting this bug!
1010

1111
If this is related to a typo or the documentation being unclear, please click on
12-
the page's `Edit` button (pencil icon) and submit a correction instead.
12+
the relevant page's `Edit` button (pencil icon) and suggest a correction
13+
instead.
1314

1415
Please search other issues to make sure this bug has not already been reported.
1516

@@ -25,9 +26,8 @@ Step-by-step instructions on how to reproduce the behavior.
2526

2627
Example:
2728

28-
1. Use the default configuration.
29-
2. Type the following command: [...]
30-
3. etc.
29+
1. Type the following command: [...]
30+
2. etc.
3131

3232
**Expected behavior**
3333

.github/pull_request_template.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
🎉 Thanks for sending this pull request! 🎉
22

3-
If you are fixing a typo or documentation, please skip these instructions.
3+
Please make sure the title is clear and descriptive.
44

5-
Otherwise please:
5+
If you are fixing a typo or documentation, please skip these instructions.
66

7-
- add a clear and descriptive title.
8-
- fill in the sections below.
7+
Otherwise please fill in the sections below.
98

109
**Which problem is this pull request solving?**
1110

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
🎉 Thanks for considering contributing to this project! 🎉
44

5-
This document will help you send a pull request.
5+
These guidelines will help you send a pull request.
66

7-
If you're submitting an issue instead, you can skip this.
7+
If you're submitting an issue instead, please skip this document.
88

99
If your pull request is related to a typo or the documentation being unclear,
10-
please click on the page's `Edit` button (pencil icon) and directly submit a
11-
correction instead.
10+
please click on the relevant page's `Edit` button (pencil icon) and directly
11+
suggest a correction instead.
1212

1313
This project was made with ❤️. The simplest way to give back is by starring and
1414
sharing it online.
@@ -41,13 +41,16 @@ to learn how to use them. You don't need to know Gulp to use these tasks.
4141

4242
# Requirements
4343

44+
After submitting the pull request, please make sure the Continuous Integration
45+
checks are passing.
46+
4447
We enforce 100% test coverage: each line of code must be tested.
4548

46-
Documentation must be added for any new feature in all of these:
49+
New options, methods, properties, configuration and behavior must be documented
50+
in all of these:
4751

4852
- the `README.md`
4953
- the `docs` directory (if any)
5054
- the `examples` directory (if any)
5155

52-
After submitting the pull request, please make sure the Continuous Integration
53-
checks are passing.
56+
Please use the same style as the rest of the documentation and examples.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ This project was made with ❤️. The simplest way to give back is by starring
136136
sharing it online.
137137

138138
If the documentation is unclear or has a typo, please click on the page's `Edit`
139-
button (pencil icon) and submit a correction.
139+
button (pencil icon) and suggest a correction.
140140

141141
If you would like to help us fix a bug or add a new feature, please check our
142142
[guidelines](CONTRIBUTING.md). Pull requests are welcome!

0 commit comments

Comments
 (0)