Skip to content

Commit 40fe55b

Browse files
Docs: Add CONTRIBUTING.md (fixes #9)
1 parent 3fefbf3 commit 40fe55b

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
Thanks for contributing!
4+
5+
## Installation
6+
7+
```bash
8+
git clone https://github.com/not-an-aardvark/eslint-plugin-prettier.git
9+
cd eslint-plugin-prettier
10+
npm install
11+
```
12+
13+
## Running the tests
14+
15+
```bash
16+
npm test
17+
```
18+
19+
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.
20+
21+
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`.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,7 @@ To install `prettier`, use:
7272
```bash
7373
npm install prettier --save-dev
7474
```
75+
76+
## Contributing
77+
78+
See [CONTRIBUTING.md](https://github.com/not-an-aardvark/eslint-plugin-prettier/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)