|
1 |
| -# Contribution Guideline |
| 1 | +# Contribution Guidelines |
2 | 2 |
|
3 |
| -Thanks for considering to contribute this project. All issues and pull requests are highly appreciated. |
| 3 | +Thanks for your interest in contributing this project. All issues and pull requests are highly appreciated! |
4 | 4 |
|
5 | 5 | ## Pull Requests
|
6 | 6 |
|
7 |
| -Before sending pull request to this project, please read and follow guidelines below. |
| 7 | +Before sending a pull request to this project, please read and follow guidelines: |
8 | 8 |
|
9 |
| -1. Branch: We only accept pull request on `master` branch. |
10 |
| -2. Coding style: Follow the coding style used in DoraemonKit. |
11 |
| -3. Commit message: Use English and be aware of your spell. |
12 |
| -4. Test: Make sure to test your code. |
| 9 | +1. Branch: We only accept pull requests on the `master` branch |
| 10 | +2. Coding style: Follow the coding style used in DoraemonKit |
| 11 | +3. Commit message: Use English and check your spelling |
| 12 | +4. Test: Make sure to test your code |
13 | 13 |
|
14 | 14 | Add device mode, API version, related log, screenshots and other related information in your pull request if possible.
|
15 | 15 |
|
16 |
| -NOTE: We assume all your contribution can be licensed under the [Apache License 2.0](https://github.com/didi/DoraemonKit/blob/master/LICENSE). |
| 16 | +NOTE: We assume all contributions can be licensed under the [Apache License 2.0](https://github.com/didi/DoraemonKit/blob/master/LICENSE). |
17 | 17 |
|
18 | 18 | ## Issues
|
19 | 19 |
|
20 | 20 | We love clearly described issues. :)
|
21 | 21 |
|
22 |
| -Following information can help us to resolve the issue faster. |
| 22 | +The following information can help us resolve the issue faster: |
23 | 23 |
|
24 |
| -* Device mode and hardware information. |
25 |
| -* API version. |
26 |
| -* Logs. |
27 |
| -* Screenshots. |
28 |
| -* Steps to reproduce the issue. |
| 24 | +* Device mode and hardware information |
| 25 | +* API version |
| 26 | +* Logs |
| 27 | +* Screenshots |
| 28 | +* Steps to reproduce the issue |
0 commit comments