diff options
author | Justin Dickow <jjdickow@gmail.com> | 2015-06-02 15:33:20 -0400 |
---|---|---|
committer | Justin Dickow <jjdickow@gmail.com> | 2015-06-02 15:33:20 -0400 |
commit | 1c809a4daea2da91152f92aff7bb02b0383916ac (patch) | |
tree | 7524967ee85fe5053a7085b3fc4219de51017816 | |
parent | c1a793421120922ad9c1614d19a87e6a67813686 (diff) | |
download | sdl_core-1c809a4daea2da91152f92aff7bb02b0383916ac.tar.gz |
Update contributing
-rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d28d6b7cb5..db408b7e9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,25 @@ -# Contributing to sdl_core +# Contributing to SDL Projects -Third party contributions are essential for making this repository great. However, we do have a few guidelines we need contributors to follow. +Third party contributions are essential for making SDL great. However, we do have a few guidelines we need contributors to follow. + +### Issues +If writing a bug report, please make sure <a href="http://yourbugreportneedsmore.info" target="_blank">it has enough info</a>. Include all relevant information. + +If requesting a feature, understand that we appreciate the input! However, it may not immediately fit our roadmap, and it may take a while for us to get to your request. ### 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: +We use <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow</a> as our branch management system. Please follow gitflow's guidelines while contributing to any SDL project. +### Pull Requests +* Please follow the repository's for all code and documentation. * 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). +* Minor bug fixes, that is bug fixes that do not change, add, or remove any public API, should be based on `master` and have the format `hotfix/branch_name`. +* All pull requests should implement a single feature or fix a single bug. Pull Requests that involve multiple changes (it is our discretion what precisely this means) will be rejected with a reason. +* All commits should separated into logical units, i.e. unrelated changes should be in different commits within a pull request. +* Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you believe the pull request is ready to merge, remove this tag and @mention the appropriate SDL team to schedule a review. +* All new code *must* include unit tests. Bug fixes should have a test that fails previously and now passes. All new features should be covered. If your code does not have tests, or regresses old tests, it will be rejected. +* A great example of a <a href="https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45" "_target>pull request can be found here</a>. ### 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) +In order to accept Pull Requests from contributors, you must first sign [the Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform). If you need to make a change to information that you entered, [please contact us](mailto:justin@livio.io). + |