Merge pull request #2 from cvent/issue-144

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+First of all, many thanks for considering making a contribution to this project.
+
+# Submitting PRs
+Please do not include any changes to `package-lock.json` in your PRs, even if you are updating package.json. These changes are almost impossible to review for security implications. If necessary, `package-lock.json` will be regenerated and committed by a maintainer after your PR is merged.
+
+Please run the tests before submitting your pull request.
+
+`npm run lint`
+`npm test`
+
+# Known bugs
+[GitHub search](https://github.com/Mermade/oas-kit/search?utf8=%E2%9C%93&q=fixme+language%3Ajavascript&type=)

README.md

@@ -29,7 +29,8 @@ Any LTS version. It is **not** recommended to use Node.js 12.17.x,12.18.x or 12.
 * `npm i` in the top level directory
 * `npx lerna bootstrap`
 
-Please try and keep commits related to a single package or piece of functionality. PR in the usual way.
+Please try and keep commits related to a single package or piece of functionality. Please review the
+(CONTRIBUTING.md)[CONTRIBUTING.md] for additional details.
 
 ## Supporting development