chore: adds ".nvmrc" and contribution guidelines

apiaryio · Jul 10, 2019 · 73b7a95 · 73b7a95
1 parent 54d3f12
commit 73b7a95
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v8.12.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing
+
+Thank you for deciding to contribute to Gavel.js. Please read the guidelines below to ensure the smoothest developer's experience during the involvement.
+
+## Workflow
+
+1. Clone the repository.
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Use the correct NodeJS version:
+
+```bash
+nvm use
+```
+
+4. Create a branch for a feature or a bugfix.
+5. Follow the [Conventional Commit Messages](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#user-content--git-commit-guidelines) for commit messages.
+6. Issue a pull request and undergo a code review.
+7. Upon approval, merge the pull request.