diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2016-02-26 09:36:48 -0500 |
---|---|---|
committer | Joel Fischer <joeljfischer@gmail.com> | 2016-02-26 09:36:48 -0500 |
commit | ff763ddf26049992b0c779ada0167f697ceaeffc (patch) | |
tree | 46b5365ef88236ecb632b67b55046e3e85bd2bec /.github/CONTRIBUTING.md | |
parent | 2c6e59a757d0c12a28600545372dc82787ddae9c (diff) | |
download | sdl_ios-ff763ddf26049992b0c779ada0167f697ceaeffc.tar.gz |
Move CONTRIBUTING file to .github/ folder
* Minor updates to ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r-- | .github/CONTRIBUTING.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..4d8fd2d05 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to SDL Projects + +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 <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, 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="_blank">pull request can be found here</a>. + +### Contributor's License Agreement (CLA) +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). + +### Repository Specific Guidelines + * <a href="https://github.com/smartdevicelink/sdl_ios/wiki/Objective-C-Style-Guide" target="blank">iOS Style Guide</a> + * Please document all code written using [Objective-C style documentation](http://nshipster.com/documentation/) for methods (we use [VVDocumenter](https://github.com/onevcat/VVDocumenter-Xcode) for methods and use inline code comments where it makes sense, i.e. for non-obvious code chunks. |