Skip to content

Commit f8c9432

Browse files
Create CONTRIBUTING.md
1 parent 9c6bfdc commit f8c9432

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# CONTRIBUTING
2+
3+
Please familiarize yourself with the [Contributor Code of Conduct](https://github.com/Node-Virtualization/node-virtualbox/blob/master/code_of_conduct.md)
4+
5+
## Filing Issues
6+
7+
- Please file issues using the issue templates.
8+
9+
- Please follow the issue template exactly and provide as much meaningful detail as you can.
10+
11+
## Testing Your Work
12+
13+
Please test your work thoroughly before submitting a PR.
14+
15+
Understand that Node-Virtualbox is used on a wide variety of platforms; avoid code that applies only to one host operating system and make it as generic as possible.
16+
17+
## Submitting Pull Requests
18+
19+
1. Pull requests *must* be tied to an issue. If no issue exists, please file one (see above).
20+
1. Before starting work, please claim the issue by commenting on it and letting _everyone_ know you'll be working on it. This helps prevent duplicate PRs.
21+
1. Please try to let us know if you abandon an issue so we can remove the `in-progress` label.
22+
1. Mention the issue number in a commit.
23+
1. Fix any issues in the automated PR checks, or explain why they're not relevant.
24+
25+
## Code Quality Tools
26+
27+
Checking tools are there as guidance. Use your judgement.

0 commit comments

Comments
 (0)