Skip to content

Commit 3e035d5

Browse files
committed
chore(project): Add project support docs
- Add license - Add PR and Issue templates - Add Contributing.md
1 parent 4e7dc5a commit 3e035d5

File tree

4 files changed

+139
-0
lines changed

4 files changed

+139
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## **BEFORE YOU SUBMIT** please read the following:
2+
If you have a support request or question please
3+
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.
4+
(remove this from issue)
5+
6+
7+
8+
**I'm submitting a bug report**
9+
**I'm submitting a feature request**
10+
**I'm submitting a support request** => Please do not submit support request here, see note at the top of this template.
11+
(remove inappropriate sentences)
12+
13+
14+
**Webpack version:**
15+
1.10.x / 2.x
16+
17+
**HTML-Loader version:**
18+
0.3.x / 0.4.x
19+
20+
**Please tell us about your environment:**
21+
OSX 10.x / Linux / Windows 10
22+
23+
24+
**Current behavior:**
25+
26+
27+
**Expected/desired behavior:**
28+
29+
30+
* **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.**
31+
32+
33+
* **What is the expected behavior?**
34+
35+
36+
* **What is the motivation / use case for changing the behavior?**
37+
38+
39+
* **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 ]
40+
41+
* **Language:** [all | TypeScript X.X | ES6/7 | ES5 | Dart | ...]

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
**Please check if the PR fulfills these requirements**
2+
- [ ] Tests for the changes have been added (for bug fixes / features)
3+
- [ ] Docs have been added / updated (for bug fixes / features)
4+
5+
6+
**What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
7+
- [ ] Bugfix
8+
- [ ] Feature
9+
- [ ] Code style update (formatting, local variables)
10+
- [ ] Refactoring (no functional changes, no api changes)
11+
- [ ] Build related changes
12+
- [ ] CI related changes
13+
- [ ] Other... Please describe:
14+
15+
**What is the current behavior?** (You can also link to an open issue here)
16+
17+
18+
19+
**What is the new behavior?**
20+
21+
22+
23+
**Does this PR introduce a breaking change?**
24+
- [ ] Yes
25+
- [ ] No
26+
27+
If this PR contains a breaking change, please describe the following...
28+
29+
* Impact:
30+
* Migration path for existing applications:
31+
* Github Issue(s) this is regarding:
32+
33+
34+
**Other information**:

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
From opening a bug report to creating a pull request: every contribution is
4+
appreciated and welcome. If you're planning to implement a new feature or change
5+
the api please create an issue first. This way we can ensure that your precious
6+
work is not in vain.
7+
8+
## Issues
9+
10+
Most of the time, if webpack is not working correctly for you it is a simple configuration issue.
11+
12+
If you are having difficulty, please search the [StackOverflow with the webpack tag](http://stackoverflow.com/tags/webpack) for questions related
13+
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
14+
the [webpack Gitter](https://gitter.im/webpack/webpack) and include both your webpack & html-loader versions.
15+
16+
**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.**
17+
18+
## Setup
19+
20+
```bash
21+
git clone https://github.com/webpack/html-loader.git
22+
cd html-loader
23+
npm install
24+
```
25+
26+
To run the entire test suite use:
27+
28+
```bash
29+
npm test
30+
```
31+
32+
## Submitting Changes
33+
34+
After getting some feedback, push to your fork and submit a pull request. We
35+
may suggest some changes or improvements or alternatives, but for small changes
36+
your pull request should be accepted quickly.
37+
38+
Some things that will increase the chance that your pull request is accepted:
39+
40+
* Write tests
41+
* Follow the existing Webpack coding style defined in the eslint jsbeutify and editor config rules.
42+
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(The MIT License)
2+
3+
Copyright (c) 2012-2016 Tobias Koppers
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
'Software'), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)