Skip to content

Latest commit

 

History

History
54 lines (29 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

54 lines (29 loc) · 1.41 KB
Raw

Contributing to KOOM

Welcome to the KOOM project and report Issues or pull requests.

Issues

We use GitHub issues to track public bugs and feature requests.

Search Known Issues First

Please search the existing issues to see if any similar issue or feature request has already been filed. You should make sure your issue isn't redundant.

Reporting New Issues

If you open an issue, the more information the better. Such as detailed description, screenshot or video of your problem, logcat or code blocks for your crash.

Pull Requests

Welcome your pull request.

Branch Management

There are two main branches:

  1. master branch

    • It's the latest (pre-)release branch. We use master for tags.
    • Please do NOT submit any PR on master branch.

  2. dev branch

    • It's our stable developing branch.
    • Please always submit PR on dev branch.

Pull Requests

Please make sure the following is done when submitting a pull request:

  1. Fork the repo and create your branch from dev.
  2. Add the copyright notice to the top of any new files you've added.
  3. Try your best to test your code.
  4. Squash all of your commits into one meaningful commit.

Code Style Guide

  1. 2 spaces for indentation rather than tabs.
  2. Follow the C code style already in place.

License

By contributing to KOOM, you agree that your contributions will be licensed under its Apache LICENSE.