From 3e035d52b0d180467c336f89937766e6fc1bf1fc Mon Sep 17 00:00:00 2001 From: d3viant0ne Date: Sat, 23 Jul 2016 10:15:32 -0500 Subject: [PATCH] chore(project): Add project support docs - Add license - Add PR and Issue templates - Add Contributing.md --- .github/ISSUE_TEMPLATE.md | 41 +++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 34 ++++++++++++++++++++++++++ CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++ LICENSE | 22 +++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..97ab865f --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,41 @@ +## **BEFORE YOU SUBMIT** please read the following: +If you have a support request or question please +submit them to [StackOverflow](http://stackoverflow.com/questions/tagged/webpack) using the tag `[webpack]` or the [webpack Gitter](https://gitter.im/webpack/webpack). Future support requests will be closed. +(remove this from issue) + + + +**I'm submitting a bug report** +**I'm submitting a feature request** +**I'm submitting a support request** => Please do not submit support request here, see note at the top of this template. +(remove inappropriate sentences) + + +**Webpack version:** +1.10.x / 2.x + +**HTML-Loader version:** +0.3.x / 0.4.x + +**Please tell us about your environment:** +OSX 10.x / Linux / Windows 10 + + +**Current behavior:** + + +**Expected/desired behavior:** + + +* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem along with a gist/jsbin of your webpack configuration.** + + +* **What is the expected behavior?** + + +* **What is the motivation / use case for changing the behavior?** + + +* **Browser:** [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ] + +* **Language:** [all | TypeScript X.X | ES6/7 | ES5 | Dart | ...] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e8925037 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +**Please check if the PR fulfills these requirements** +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + + +**What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting, local variables) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Build related changes +- [ ] CI related changes +- [ ] Other... Please describe: + +**What is the current behavior?** (You can also link to an open issue here) + + + +**What is the new behavior?** + + + +**Does this PR introduce a breaking change?** +- [ ] Yes +- [ ] No + +If this PR contains a breaking change, please describe the following... + +* Impact: +* Migration path for existing applications: +* Github Issue(s) this is regarding: + + +**Other information**: \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..024b96e8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +From opening a bug report to creating a pull request: every contribution is +appreciated and welcome. If you're planning to implement a new feature or change +the api please create an issue first. This way we can ensure that your precious +work is not in vain. + +## Issues + +Most of the time, if webpack is not working correctly for you it is a simple configuration issue. + +If you are having difficulty, please search the [StackOverflow with the webpack tag](http://stackoverflow.com/tags/webpack) for questions related +to the `html-loader`. If you can find an answer to your issue, please post a question in [StackOverflow](http://stackoverflow.com/tags/webpack) or +the [webpack Gitter](https://gitter.im/webpack/webpack) and include both your webpack & html-loader versions. + +**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.** + +## Setup + +```bash +git clone https://github.com/webpack/html-loader.git +cd html-loader +npm install +``` + +To run the entire test suite use: + +```bash +npm test +``` + +## Submitting Changes + +After getting some feedback, push to your fork and submit a pull request. We +may suggest some changes or improvements or alternatives, but for small changes +your pull request should be accepted quickly. + +Some things that will increase the chance that your pull request is accepted: + +* Write tests +* Follow the existing Webpack coding style defined in the eslint jsbeutify and editor config rules. +* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..6b7efca7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +(The MIT License) + +Copyright (c) 2012-2016 Tobias Koppers + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file