Skip to content

Commit 9ad524c

Browse files
author
Mike Burke
committed
Merge pull request #70 from mikeburke106/hotfix/Contributing_File
Add a CONTRIBUTING file
2 parents c239f72 + ecdb1be commit 9ad524c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

sdl_android_lib/CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing to sdl_android
2+
3+
Third party contributions are essential for making this repository great. However, we do have a few guidelines we need contributors to follow.
4+
5+
### Gitflow
6+
We use Gitflow as our branch management system. Please read up on it [here](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). The main points you should know are:
7+
8+
* All feature branches should be based on `develop` and have the format `feature/branch_name`.
9+
* Minor bug fixes should be based on `master` and have the format `hotfix/branch_name`.
10+
* All commits should involve logical units. Please do not put all changed code in one commit, unless it is a very minor change.
11+
* 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.
12+
* If applicable, follow [this Pull Request's format](https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45).
13+
* Please document all code written. Write [JavaDoc style documentation](http://www.oracle.com/technetwork/articles/java/index-137868.html) for methods, and use inline code comments where it makes sense, i.e. for non-obvious code chunks.
14+
15+
### Contributor's License Agreement (CLA)
16+
Coming Soon! We unfortunately cannot accept third party contributions until this is ready.

0 commit comments

Comments
 (0)