Add .github folder along with new Issue and PR templatesfeature/issue_pr_template

4 files changed, 61 insertions, 103 deletions

diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 42cf5d0898..6daef5fe25 100644
--- a/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -3,21 +3,21 @@
 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 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 <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.
+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 for all code and documentation.
+* 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 defect should be fixed in short time (after release), send pull request to `master` and have the format `hotfix/branch_name`. 
-* In case defect exists in `develop` and `master` branches, send pull request to `develop` only. Do not send the same pull request to the `master` 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.
@@ -30,6 +30,3 @@ In order to accept Pull Requests from contributors, you must first sign [the Con
 ## Additional Resources
 * [General GitHub documentation](https://help.github.com/)
 * [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
-* [Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform)
-* [Committers.md](https://github.com/LuxoftSDL/sdl_core/blob/feature/Add_Committers_file/COMMITTERS.md)
-
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
diff --git a/COMMITTERS.md b/COMMITTERS.md
deleted file mode 100644
index 210fceb421..0000000000
--- a/COMMITTERS.md
+++ /dev/null
@@ -1,95 +0,0 @@
-#Committing changes to SDL

-

-We would like to make it easier for community members to contribute to SDL

-using pull requests. This makes the process of contributing a little easier for the contributor since they don't

-need to concern themselves with the question, "What branch do I base my changes

-on?"  This is already called out in the CONTRIBUTING.md.

-

-##Terminology

-Many of these terms have more than one meaning. For the purposes of this

-document, the following terms refer to specific things.

-

-**contributor** - A person who makes a change to SDL and submits a change

-set in the form of a pull request.

-

-**reviewer** - A person responsible for reviewing a pull request.

-

-**master branch** - [The base branch](https://github.com/smartdevicelink/sdl_core/tree/master).

-

-**develop branch** - [The branch](https://github.com/LuxoftSDL/sdl_core/tree/develop) where bug fixes against the latest release or release candidate are merged.

-

-## Pre-commit hook installation

-* Go to tools/infrastructure/

-* Run install-hooks.py

-* or : Just run "python tools/infrastructure/install-hooks.py"

-

-##Pull request checklist

-* Add Unit tests.

-* All tests pass (see Run all tests section).

-* Check component design

-* Check amount of required memory, memory leaks.

-* Assertion must be used in the right way.

-* Are there cyclic dependencies?

-* Level of abstraction adequate?

-* Are there any platform gotchas? (Does a change make an assumption about

-   platform specific behavior that is incompatible with other platforms?  e.g.

-   Windows paths vs. POSIX paths).

-* Thread safe code.

-* No deadlocks.

-* Is Doxygen API documentation available?

-* Do you have thread specific comment provided? (if another thread uses added method/classes, 

-   there must be comment which explains: When method will be called by thread? Which thread calls the method? e.g.)

-* Do you have specific realization code comments?

-* Add log messages.

-* There are no Google code style errors. (You can download Google [cpplint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py))

-* Check branch naming.

-* Check correct commit messages in commits (see Pull request message section).

-* Check correct pull request target (`master` or `develop`)

-* Check correct pull request message

-* Add reviewers

-

-##Run all tests

-* Run in root build directory `make test`

-

-##Branch naming

-Branch name should be:

-* `hotfix/<task name>` or

-* `feature/<task name>` or

-* `fix/<task name>`

-

-##Pull request message

-* Describe the reason why you created pull request and what changes there are.

-* Add related Jira ticket as link.

-   ( EXAMPLE:

-   `Related: [APPLINK-xxxxx](put direct link here)`)

-* If there was an old pull request, add link. ( EXAMPLE: `Old pull request is [here](put direct link here)`)

-

-##Adding reviewers:

-* Add one domain expert

-* Add your mentor (for junior developers only)

-* Add all junior developers (for junior developers only)

-

-`Note`: Everyone from SDL team developers can review any pull request (“reviewed” comment is not required)

-

-##Review process

-* Reviewers can leave comments to code only in `commits` tab.

-* Contributor must answer each comment (Contributor should specify addressee in comment).

-* In case contributor is disagree with reviewer, contributor writes his opinion

-* In case contributor is agree with reviewer, contributor leaves link to new commit with changes.

-* When reviewer is agree with all changes in pull request, he must leave `Reviewed` comment.

-

-##Successfully passed review:

-* Contributor answered to all comments

-* Contributor fixed all mistakes

-* All reviewers left `Reviewed` comment

-

-##Merging

-* Successfully passed review.

-* Rebase in case of existing conflicts.

-* Contributor can squash commits in case of adding same code in different commits.

-* Contact @AGaliuzov or @anosach-luxoft to merge pull request.

-

-##Additional sources

-* [Google cppint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py)

-* [Git commit best practices](http://chris.beams.io/posts/git-commit/)

-* [GitHub Working with formatting](https://help.github.com/articles/working-with-advanced-formatting/)