Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.46 KB
Raw

Contributing

Thank you for your interest in contributing to iBurn! Please open up an issue on our tracker before starting work on major interface or functionality changes. The easiest place to start is the list of bugs on the issue tracker. Otherwise, feel free to run wild!

  1. Fork the project and do your work in a feature branch.
  2. Make sure everything compiles and existing functionality is not broken.
  3. Open a pull request.
  4. Thank you! :)

Your contributions will need to be licensed to us under the MPL 2.0 and will be distributed under the terms of the MPL 2.0.

Style

Some general guidelines for style. Not a hard rule, but can be helpful to see what other people recommend.

Code Review

  • Every feature/bugfix/etc should be done in a feature branch, and correspond to a single PR.
  • To merge into master, submit a PR on GitHub to allow for code review.

Tests

  • When applicable, code should be written in a way that facilitates testing.
  • Whenever possible, new code should be accompanied by unit tests and integration tests.
  • TDD (test driven development) is very helpful for quick iteration.