From cce9e334f9d04b306dcf8e08d55b7293cc0f1b10 Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Wed, 23 Oct 2019 18:54:03 -0400 Subject: [PATCH] update contributing --- CONTRIBUTING.md | 46 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de88fc85..88f98472 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,50 @@ -# contributing to express-openapi-vaidator +# Contributing + +Contributors are welcome! + +See something that needs fixing? Got an idea for a new feature? Contribute! ## Prerequisites / Setup -- Fork the repo -- Clone your copy `git clone ` -- `npm install` +1. Fork the repo + + ```shell + # The clone your copy + git clone + ``` + +2. Install the dependencies + + ```shell + # From the project directory, run + npm i + ``` ## Run the tests -```shell -npm test -``` +3. Run the tests + + ```shell + npm test + ``` + +## Develop + +- Write code +- Add tests to validate new behaviors +- Ensure all tests succeed +- Create a PR +- Have fun! ## Project structure `src` contains the source code `test` contains the tests -## Need help +## Need help? + +Reach out on [gitter](https://gitter.im/cdimascio-oss/community). + +We're happy to help! -Reach out on [gitter](https://gitter.im/cdimascio-oss/community) \ No newline at end of file +## Thanks!