Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

53 lines (41 loc) · 2.56 KB
Raw

Contributing to Ohm

Interested in contributing to Ohm? This document explains our guidelines for submitting pull requests to the Ohm GitHub repository. For information on how to get started with Ohm development, please see the contributor guide.

Before submitting

If you think you've found a bug in Ohm, please file an issue describing the problem before submitting a PR. If the fix is non-trivial, it's usually best to wait for a response before putting a lot of work into a fix.

For new features, it's also best to discuss the idea with us (via an issue or an email to the mailing list) before submitting a pull request.

Also, please ensure the tests pass (using npm test) and that there are no lint errors -- though the pre-commit hook should do this automatically.

Formatting

To make the review process easier and maximize the chances that your pull request is accepted, here are some guidelines:

  • Use informative commit messages that follow the standard git commit template.
  • Include only the changes that are relevant to your bug/feature. Before submitting, take a look over the diff to ensure that you haven't included any unrelated changes.
  • Try to keep your pull requests small -- anything more than a few hundred lines is too big. If necessary, break your changes up into several small PRs.

Review Process

When you submit a pull request, one of the Ohm developers will review it and (most likely) leave comments on it. Don't worry -- this is not about judging you, it's about improving the code and helping you get your pull request integrated into the project. A code review is a dialog; it shouldn't be seen as an inspection or approval process.

Here are the steps involved in a typical review:

  • You submit your pull request, including a descriptive message describing its purpose.
  • An Ohm team member leaves comments on your code, with questions and suggestions.
  • You follow up on each comment by answering the question, incorporating the suggestion, or explaining why you disagree.
  • When the reviewer thinks your PR is ready to be merged, they will respond with a comment saying "LGTM", meaning "looks good to me". At this point, if you have permission, you should now merge your PR into main. If not, the reviewer will merge it for you.