From 41d3029c1698e5b12a529a44fd2c0bae8f66202d Mon Sep 17 00:00:00 2001 From: Jacob Keeler Date: Tue, 3 Oct 2017 16:17:26 -0400 Subject: Add .github folder along with new Issue and PR templates (#1800) --- .github/CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 23 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 88 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..6daef5fe25 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# 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 [you follow the issue template](https://github.com/smartdevicelink/sdl_core/blob/master/.github/ISSUE_TEMPLATE.md). 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](http://nvie.com/posts/a-successful-git-branching-model/) as our branch management system. Please follow GitFlow's guidelines while contributing to any SDL project. + +### Pull Requests +* Please follow the repository's [Style Guide](https://github.com/smartdevicelink/sdl_core/wiki/SDL-Coding-Style-Guide) for all code and documentation. +* All pull requests should be sent to `smartdevicelink/sdl_core/`, to `develop` or `master` branch. +* All feature branches should be based on `develop` and have the format `feature/branch_name`. +* All fix branches should be based on `develop` and have the format `fix/branch_name`. +* All new functionality requests should be provided only for `develop` branch. +* In case an issue should be fixed in a short time (after release), open a pull request to `master` with a branch name of `hotfix/branch_name`. +* In case an issue exists in both the `develop` and `master` branches, open a pull request to `develop` only. Do not open the same pull request against the `master` branch. +* 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 be 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 [pull request can be found here](https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45). + +### 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:theresa@livio.io). + +## Additional Resources +* [General GitHub documentation](https://help.github.com/) +* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..1b58b20e86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,23 @@ +[Delete any non-applicable sections, but we may ask for more information.] + +### Bug Report +[Summary] + +##### Reproduction Steps +1. [Step 1] +2. [Step 2] +3. [Step 3] + +##### Expected Behavior +[Some expected behavior] + +##### Observed Behavior +[Some observed behavior] + +##### OS & Version Information +* OS/Version: [The OS/Version you were running when the bug occurred] +* SDL Core Version: [The version of SDL Core you were using when the bug occurred] +* Testing Against: [What you tested with to observe this behavior. Proxy, App, HMI etc.] + +##### Test Case, Sample Code, and / or Example App +[Paste a link to a PR, gist, or other code that exemplifies this behavior] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..83c3261f9b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ +[Things to note: Pull Requests **must** fix an issue. Discussion about the feature / bug takes place in the issue, discussion of the implementation takes place in the PR. Please also see the [Contributing Guide](https://github.com/smartdevicelink/sdl_core/blob/master/.github/CONTRIBUTING.md) for information on branch naming and the CLA. + +Delete the above section when you've read it.] + +Fixes #[issue number] + +This PR is **[ready / not ready]** for review. + +### Risk +This PR makes **[no / minor / major]** API changes. + +### Testing Plan +[Describe how you plan to unit test the changes in this PR] + +### Summary +[Summary of PR changes] + +### Changelog +##### Breaking Changes +* [Breaking change info] + +##### Enhancements +* [Enhancement info] + +##### Bug Fixes +* [Bug Fix Info] + +### Tasks Remaining: +- [ ] [Task 1] +- [ ] [Task 2] + +### CLA +- [ ] I have signed [the CLA](https://docs.google.com/forms/d/e/1FAIpQLSdsgJY33VByaX482zHzi-xUm49JNnmuJOyAM6uegPQ2LXYVfA/viewform) \ No newline at end of file -- cgit v1.2.1