Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.62 KB

Contributing to Forrest

Forrest is a community-driven project. As such, we welcome and encourage all sorts of contributions. They include, but are not limited to:

  • Constructive feedback
  • Questions about usage
  • Documentation changes
  • Feature requests
  • Pull requests

We strongly suggest that before filing an issue, you search through the existing issues to see if it has already been filed by someone else.

Contribution suggestions

We use the label help wanted in the issue tracker to denote fairly-well-scoped-out bugs or feature requests that the community can pick up and work on. If any of those labeled issues do not have enough information, please feel free to ask constructive questions. (This applies to any open issue.)

Filing Pull Requests

Here are some things to keep in mind as you file pull requests to fix bugs, add new features, etc.:

  • Travis CI is used to make sure that the project builds packages as expected on the supported platforms, using supported Node.js versions.
  • Please make sure your commits are rebased onto the latest commit in the master branch, and that you limit/squash the number of commits created to a "feature"-level. For instance:

bad:

commit 1: add foo option
commit 2: standardize code
commit 3: add test
commit 4: add docs
commit 5: add bar option
commit 6: add test + docs

good:

commit 1: add foo option
commit 2: add bar option

For Collaborators

Make sure to get a :thumbsup:, +1 or LGTM from another collaborator before merging a PR.