diff options
| author | Justin Dickow <jjdickow@gmail.com> | 2015-01-27 09:31:05 -0500 |
|---|---|---|
| committer | Justin Dickow <jjdickow@gmail.com> | 2015-01-27 09:31:05 -0500 |
| commit | 28701a618a8630d27d7473607a592f0781359fec (patch) | |
| tree | e1173f994837df151f762ef835899129a5bef1db | |
| parent | 1bb9c8e9b3b7ab2415a9ca2d3b40e83668d2f406 (diff) | |
| download | smartdevicelink-28701a618a8630d27d7473607a592f0781359fec.tar.gz | |
Added contributing file, fixes #4
Signed-off-by: Justin Dickow <jjdickow@gmail.com>
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d28d6b7cb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing to sdl_core + +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](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). 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](https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45). + +### Contributor's License Agreement (CLA) +Coming Soon! Unfortunately, we cannot accept third party contributions until this is ready. We are working quickly on the CLA as we have contributions waiting! (A good problem to have) |