-
-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #216 from streamich/pr/215
Pr/215
- Loading branch information
Showing
2 changed files
with
6 additions
and
43 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 |
---|---|---|
@@ -1,40 +1,4 @@ | ||
# Contributing to `memfs` | ||
|
||
To get started, download the project to your machine: | ||
|
||
git clone https://github.com/streamich/memfs | ||
cd memfs | ||
|
||
Start from the `develop` branch: | ||
|
||
git checkout develop | ||
git checkout -b your-feature | ||
|
||
Install dependencies: | ||
|
||
npm install | ||
|
||
Also, you probably want to use the latest Node.js version and `ts-node` | ||
to be able to run TypeScript files: | ||
|
||
npm install -g ts-node | ||
|
||
While developing your feature you can create a demo file and place it | ||
in `demo/feature.ts`, run it like this: | ||
|
||
ts-node demo/feature.ts | ||
|
||
Don't forget to write unit tests for you feature, test files have `.test.ts` | ||
extension. | ||
|
||
Run tests using this command: | ||
|
||
npm run test-coverage-ts | ||
|
||
Also make sure that your test cases cover your new code well. | ||
|
||
When done, build the project: | ||
|
||
npm run build | ||
|
||
Submit a pull request into the `develop` branch. | ||
1. Use [Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for commit messages. | ||
2. Add tests for for code you add. |
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