From 7046b69ad57338d0ce0f8553013eff5fec16a12f Mon Sep 17 00:00:00 2001 From: Louis Christopher Date: Sun, 8 Nov 2020 18:06:18 +0530 Subject: [PATCH] Update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b1cd294..92d0f2b 100644 --- a/README.md +++ b/README.md @@ -323,6 +323,14 @@ Model.paginate({}, options, function (err, result) { }); ``` +## Development + +- Fork and clone the repo and install dependencies. +- Ensure all tests pass before you commit by running `npm run lint && npm run prettier` +- There are pre-commit hooks that run to ensure the _files you've changed_ are formatted correctly. +- Optionally you can manually run `npm run lint && npm run prettier` +- If using VS Code, install eslint and prettier for easy editor integration. + ## Changelog [v1.3.10] - 1/11/2020