Skip to content

Commit

Permalink
docs: ✏️ update contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
streamich committed Sep 16, 2018
1 parent 078dfbe commit 36ca683
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 43 deletions.
40 changes: 2 additions & 38 deletions CONTRIBUTING.md
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.
9 changes: 4 additions & 5 deletions src/volume.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ import {Node, Link, File, Stats} from "./node";
import {Buffer} from 'buffer';
import setImmediate from './setImmediate';
import process from './process';
const extend = require('fast-extend');
const errors = require('./internal/errors');
import setTimeoutUnref, {TSetTimeout} from "./setTimeoutUnref";
import {Readable, Writable} from 'stream';
const util = require('util');
import {constants} from "./constants";
import {EventEmitter} from "events";
import {ReadStream, WriteStream} from "fs";
import errors = require('./internal/errors');
import extend = require('fast-extend');
import util = require('util');

const {O_RDONLY, O_WRONLY, O_RDWR, O_CREAT, O_EXCL, O_NOCTTY, O_TRUNC, O_APPEND,
O_DIRECTORY, O_NOATIME, O_NOFOLLOW, O_SYNC, O_DIRECT, O_NONBLOCK,
Expand Down Expand Up @@ -1016,7 +1015,7 @@ export class Volume {
fd = id as number;
} else {
const steps = filenameToSteps(id as string);
const link: Link = this.getResolvedLink(steps);
const link: Link = this.getResolvedLink(steps);

if(link) {
const node = link.getNode();
Expand Down

0 comments on commit 36ca683

Please sign in to comment.