From ba2a85025315703964e20b121bf97d0c4ef8160b Mon Sep 17 00:00:00 2001 From: Jordan Harband Date: Fri, 14 Mar 2014 23:21:31 -0700 Subject: [PATCH] Adding a CONTRIBUTING.md file --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f1f07a9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +Thanks for contributing to `nvm`! + +We love pull requests, they're our favorite. + +However, before submitting, please review the following: + + - Please include tests. Changes with tests will be merged very quickly. + - Please manually confirm that your changes, and all tests, pass in `bash`, `sh`, and `zsh`. We hope to soon automatically run all these tests, but in the meantime, we have to rely on each contributor doing so. + - Please maintain consistent whitespace - 2-space indentation, trailing newlines in all files, etc. + - Any time you make a change to your PR, please rebase freshly on top of master. Nobody likes merge commits. + +Even if you don't have all of these items covered, please still feel free to submit a PR! Someone else may be inspired and volunteer to complete it for you. + +Thanks again! +