Skip to content

Commit

Permalink
Move CONTRIBUTING.md to repo root.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed May 14, 2019
1 parent dee4185 commit c7a491f
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 22 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
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) |
22 changes: 0 additions & 22 deletions packages/cspell/CONTRIBUTING.md

This file was deleted.

0 comments on commit c7a491f

Please sign in to comment.