Skip to content

Latest commit

 

History

History
58 lines (30 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

58 lines (30 loc) · 3.21 KB
Raw

How to contribute

Want to contribute to BatteryHub? Great! We're always happy to have more contributors. Before you start, please take a look at this document.

The project is under development. We’re still working out the kinks to make contributing to this project as easy and transparent as possible, but we’re not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.

Code of Conduct

The GreenHub project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Pull Request Guidelines

We will do our best to keep the master branch in good shape, with tests passing at all times. It represents the latest version released in the Google Play Store.

  • If you send a pull request, please do it against the master branch. We maintain stable branches for major versions separately but we don't accept pull requests to them directly. Instead, we cherry-pick non-breaking changes from master to the latest stable major version.

  • dev branch represents the cutting edge version, which will become the next major release (v2.*). It is not advisable to fork this branch at the moment since it will be subject to a complete rewrite of some components.

  • 1.2 branch represents the current maintained version. This is probably the one you want to fork from and base your patch on.

  • Fix or feature branches. Proposed new features and bug fixes should live in their own branch. Use the following naming convention:

    • fix-name for fixes
    • feature-name for features

    Where name is a short description of the fix/feature of the respective branch.

Development Setup

You will need Java SE Development Kit 8 and Android SDK. Alternatively you can use Docker (refer to these instructions) if you don't want to install the Android SDK on your machine.

Committing Changes

Commit messages should follow the commit message convention.

Semantic Versioning

BatteryHub follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes.

We release new patch versions every few weeks, minor versions every few months, and major versions are unplanned.

You can read about the changes in the releases page.

How to Get in Touch

Style Guide

You can find more information about the code style convention here.

License

By contributing to BatteryHub, you agree that your contributions will be licensed under its Apache 2.0 License.

What Next?

Read the documentation to learn how the project codebase is organized.