Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.13 KB
Raw

CONTRIBUTING

Please familiarize yourself with the Contributor Code of Conduct

Filing Issues

  • Please file issues using the issue templates.

  • Please follow the issue template exactly and provide as much meaningful detail as you can.

Testing Your Work

Please test your work thoroughly before submitting a PR.

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.

Submitting Pull Requests

  1. Pull requests must be tied to an issue. If no issue exists, please file one (see above).
  2. 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.
  3. Please try to let us know if you abandon an issue so we can remove the in-progress label.
  4. Mention the issue number in a commit.
  5. Fix any issues in the automated PR checks, or explain why they're not relevant.

Code Quality Tools

Checking tools are there as guidance. Use your judgement.