From 3427bdf7a5da10178ec4b6c8cfe90a7090637ad9 Mon Sep 17 00:00:00 2001 From: Philip Scott Date: Sat, 19 Jan 2019 13:43:24 -0500 Subject: [PATCH] fix: Split contributing guide into separate file (#46) --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 14 +------------- 2 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39a31b4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## Contributing + +* Make sure your changes pass the unit tests! +* To run the tests locally, run: + +```js +npm install +npm run test +``` + +* We use the [Standard](https://standardjs.com/) style guide + * Run `npm run fix` to automatically format code to comply with the style guide + * Don't feel pressured to code in Standard! Just run `npm run fix` +* When adding a new feature, please add a unit test in `/test/test.js` +* If you have any suggestions regarding our workflow, please feel free to open an issue :smile: diff --git a/README.md b/README.md index d592f34..741ebfd 100644 --- a/README.md +++ b/README.md @@ -125,16 +125,4 @@ Contributions of any kind are welcome! ## Contributing -* Make sure your changes pass the unit tests! -* To run the tests locally, run: - -```js -npm install -npm run test -``` - -* We use the [Standard](https://standardjs.com/) style guide - * Run `npm run fix` to automatically format code to comply with the style guide - * Don't feel pressured to code in Standard! Just run `npm run fix` -* When adding a new feature, please add a unit test in `/test/test.js` -* If you have any suggestions regarding our workflow, please feel free to open an issue :smile: +See [CONTRIBUTING.md](https://github.com/ScottyFillups/simple-thumbnail/blob/master/CONTRIBUTING.md).