Skip to content

Commit 20a40dd

Browse files
PeterDaveHelloljharb
authored andcommitted
[Docs] Update CONTRIBUTING.md
1 parent 237c3a7 commit 20a40dd

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

CONTRIBUTING.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
Thanks for contributing to `nvm`!
22

3-
We love pull requests, they're our favorite.
3+
We love pull requests and issues, they're our favorite.
44

55
However, before submitting, please review the following:
66

7+
For bug reports:
8+
- Please make sure the bug is reproducible, and give us the steps to reproduce it, so that we can dig into the problem.
9+
- Please give us as much detail as possible about your environment, so we can more easily confirm the problem.
10+
11+
For pull requests:
712
- Please include tests. Changes with tests will be merged very quickly.
813
- Please manually confirm that your changes work in `bash`, `sh`/`dash`, `ksh`, and `zsh`. Fast tests do run in these shells, but it's nice to manually verify also.
914
- Please maintain consistent whitespace - 2-space indentation, trailing newlines in all files, etc.
1015
- Any time you make a change to your PR, please rebase freshly on top of master. Nobody likes merge commits.
1116

12-
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.
17+
Even if you don't have all of these items covered, please still feel free to submit a PR/issue! Someone else may be inspired and volunteer to complete it for you.
1318

1419
Thanks again!
1520

0 commit comments

Comments
 (0)