Skip to content

Commit b791f74

Browse files
guzhongrenfuzhenn
authored andcommitted
docs(README): fix path of contribution and typo (#1451)
* docs(README): fix path of contribution * docs(README): fix typo
1 parent cdfca80 commit b791f74

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Hi! It's really really exciting that you are interested in contributing to mapta
1212

1313
- Submit your PRs against the `master` branch.
1414

15-
- **DO NOT** checkin `dist` in the commits.
15+
- **DO NOT** check in `dist` in the commits.
1616

1717
- Make sure `npm test` passes. (see [development setup](#development-setup))
1818

@@ -81,7 +81,7 @@ maptalks's unit tests are run in the following CI servers:
8181

8282
Common causes of CI failures:
8383
* If your PR failes in one or two CI tests but succeeds in the others, it usually indicated a browser compatible problem.
84-
* If testing fails due to "timeout of 2000ms exceeded" errors in serverl cases which was passed in the previous testings, it's possible caused by server glitches and you can try to push more commits to trigger a re-testing.
84+
* If testing fails due to "timeout of 2000ms exceeded" errors in several cases which was passed in the previous testings, it's possible caused by server glitches and you can try to push more commits to trigger a re-testing.
8585
* Only failure of appveor may be caused by ES6 codes in unit tests, tests must be written in **ES5** as IE doesn't support ES2015 grammar.
8686

8787
## Project Structure
@@ -102,4 +102,4 @@ Common causes of CI failures:
102102

103103
- **`src`**: contains the source code, obviously. The codebase is written in ES2015.
104104

105-
- **`test`**: contains all tests written in **ES5**(for compatibility of IE). The unit tests are written with [Mocha](https://mochajs.org), [expect.js](https://github.com/Automattic/expect.js) for assertion, [happen](https://github.com/tmcw/happen) for event mocking and run with [Karma](http://karma-runner.github.io/0.13/index.html).
105+
- **`test`**: contains all tests written in **ES5**(for compatibility of IE). The unit tests are written with [Mocha](https://mochajs.org), [expect.js](https://github.com/Automattic/expect.js) for assertion, [happen](https://github.com/tmcw/happen) for event mocking and run with [Karma](http://karma-runner.github.io/0.13/index.html).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ It's easy and joyful to write plugins for maptalks, please check out [the tutori
7373
We warmly welcome any kind of contributions including issue reportings, pull requests, documentation corrections, feature requests and any other helps.
7474

7575
### Contributing Guide
76-
Please read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose fixes and improvements, and how to test your changes to maptalks.
76+
Please read our [contributing guide](.github/CONTRIBUTING.md) to learn about our development process, how to propose fixes and improvements, and how to test your changes to maptalks.
7777

7878
## Acknowledgments
7979

0 commit comments

Comments
 (0)