-
-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
40 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing | ||
|
||
These are some notes about contributing. | ||
|
||
## Continuous Integration | ||
|
||
### Travis-CI | ||
|
||
* https://travis-ci.org/streetsidesoftware/cspell | ||
|
||
### Appveyor | ||
|
||
* https://ci.appveyor.com/project/streetsidesoftware/cspell | ||
|
||
### Code Coverage | ||
|
||
* https://coveralls.io/github/streetsidesoftware/cspell | ||
|
||
### NPM | ||
|
||
* https://www.npmjs.com/package/cspell | ||
* https://www.npmjs.com/package/cspell-lib | ||
* https://www.npmjs.com/package/cspell-trie | ||
* https://www.npmjs.com/package/cspell-tools | ||
* https://www.npmjs.com/package/cspell-glob | ||
|
||
## Development | ||
|
||
Node JS version 8 or higher is required. | ||
|
||
### Commands | ||
|
||
| Command | Description | | ||
| ------- | ----------- | | ||
| `npm install` | Installs all the dependencies for all packages | | ||
| `npm run build` | To compile the typescript into javascript | | ||
| `npm test` | Runs the unit tests for all packages | | ||
| `npm run check-spelling` | Checks the spelling for all sources files | | ||
| `npm run coverage` | Generates coverage information for all projects. Open `coverage/index.html` to view coverage. | | ||
| `npx lerna publish` | To publish the packages (must have permissions) | |
This file was deleted.
Oops, something went wrong.