Skip to content

Commit

Permalink
Docs: Add CONTRIBUTING.md (fixes #9)
Browse files Browse the repository at this point in the history
  • Loading branch information
not-an-aardvark committed Apr 7, 2017
1 parent 3fefbf3 commit 40fe55b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing

Thanks for contributing!

## Installation

```bash
git clone https://github.com/not-an-aardvark/eslint-plugin-prettier.git
cd eslint-plugin-prettier
npm install
```

## Running the tests

```bash
npm test
```

This is an [ESLint](http://eslint.org) plugin. Documentation for the APIs that it uses can be found on ESLint's [Working with Plugins](http://eslint.org/docs/developer-guide/working-with-plugins) page.

This plugin is used to lint itself. The style is checked when `npm test` is run, and the build will fail if there are any linting errors. You can use `npm run lint -- --fix` to fix some linting errors. To run the tests without running the linter, you can use `node_modules/.bin/mocha tests --recursive`.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,7 @@ To install `prettier`, use:
```bash
npm install prettier --save-dev
```

## Contributing

See [CONTRIBUTING.md](https://github.com/not-an-aardvark/eslint-plugin-prettier/blob/master/CONTRIBUTING.md)

0 comments on commit 40fe55b

Please sign in to comment.