Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

16 lines (12 loc) · 1.36 KB

Contributing to sdl_android

Third party contributions are essential for making this repository great. However, we do have a few guidelines we need contributors to follow.

Gitflow

We use Gitflow as our branch management system. Please read up on it here. The main points you should know are:

  • All feature branches should be based on develop and have the format feature/branch_name.
  • Minor bug fixes should be based on master and have the format hotfix/branch_name.
  • All commits should involve logical units. Please do not put all changed code in one commit, unless it is a very minor change.
  • Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you are ready to merge, remove this tag and @mention smartdevicelink/developers to get it scheduled for review.
  • If applicable, follow this Pull Request's format.
  • Please document all code written. Write JavaDoc style documentation for methods, and use inline code comments where it makes sense, i.e. for non-obvious code chunks.

Contributor's License Agreement (CLA)

Coming Soon! We unfortunately cannot accept third party contributions until this is ready.