Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

13 lines (10 loc) · 1.78 KB
Raw

First, thank you for contributing to DIM! We're a community-driven project and we appreciate improvements large and small.

Here are some tips to make sure your pull request can be merged smoothly:

  1. If you want to add a feature or make some change to DIM, consider filing an issue describing your idea first. This will give the DIM community a chance to discuss the idea, offer suggestions and pointers, and make sure what you're thinking of fits with the style and direction of DIM.
  2. Resist the temptation to change more than one thing in your PR. Keeping PRs focused on a single change makes them much easier to review and accept. If you want to change multiple things, or clean up/refactor the code, make a new branch and submit those changes as a separate PR.
  3. Please follow the existing style of DIM code when making your changes. While there's certainly room for improvement in the DIM codebase, if everybody used their favorite code style nothing would match up.
  4. You can use any ES6/ES2015 features supported by a reasonably modern Chrome version.
  5. Take advantage of the native JavaScript Array methods and the Underscore library to write compact, easy-to-understand code.
  6. Be sure to run grunt eslint before submitting your PR - it'll catch most style problems and make things much easier to merge.
  7. Don't forget to add a description of your change to CHANGELOG.md so it'll be included in the release notes!

If you're looking to get started contributing to DIM, check out the Quick Start section of our README.