forked from webpack/schema-utils
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6ca2322
commit fc8c2de
Showing
36 changed files
with
12,118 additions
and
475 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,13 @@ | ||
root = true | ||
# editorconfig.org | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
insert_final_newline = true | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
/coverage | ||
/dist | ||
/node_modules | ||
/test/fixtures |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,4 @@ | ||
module.exports = { | ||
root: true, | ||
plugins: [ 'prettier' ], | ||
extends: [ '@webpack-contrib/eslint-config-webpack' ], | ||
rules: { | ||
'prettier/prettier': [ | ||
'error', | ||
{ singleQuote: true, trailingComma: 'es5', arrowParens: 'always' } | ||
] | ||
} | ||
extends: ['@webpack-contrib/eslint-config-webpack', 'prettier'], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
# These are the default owners for everything in | ||
# webpack-contrib | ||
|
||
@webpack-contrib/org-maintainers | ||
|
||
# Add repository specific users / groups | ||
# below here for libs that are not maintained by the org. | ||
# below here for libs that are not maintained by the org. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
# Contributing in @webpack-contrib | ||
|
||
We'd always love contributions to further improve the webpack / webpack-contrib ecosystem! | ||
Here are the guidelines we'd like you to follow: | ||
|
||
- [Questions and Problems](#question) | ||
- [Issues and Bugs](#issue) | ||
- [Feature Requests](#feature) | ||
- [Pull Request Submission Guidelines](#submit-pr) | ||
- [Commit Message Conventions](#commit) | ||
|
||
## <a name="question"></a> Got a Question or Problem? | ||
|
||
Please submit support requests and questions to StackOverflow using the tag [[webpack]](http://stackoverflow.com/tags/webpack). | ||
StackOverflow is better suited for this kind of support though you may also inquire in [Webpack Gitter](https://gitter.im/webpack/webpack). | ||
The issue tracker is for bug reports and feature discussions. | ||
|
||
## <a name="issue"></a> Found an Issue or Bug? | ||
|
||
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. | ||
|
||
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we ask that you to provide a minimal reproduction scenario (github repo or failing test case). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like: | ||
|
||
- version of Webpack used | ||
- version of the loader / plugin you are creating a bug report for | ||
- the use-case that fails | ||
|
||
A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem. | ||
|
||
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it. | ||
|
||
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced. | ||
|
||
## <a name="feature"></a> Feature Requests? | ||
|
||
You can _request_ a new feature by creating an issue on Github. | ||
|
||
If you would like to _implement_ a new feature, please submit an issue with a proposal for your work `first`, to be sure that particular makes sense for the project. | ||
|
||
## <a name="submit-pr"></a> Pull Request Submission Guidelines | ||
|
||
Before you submit your Pull Request (PR) consider the following guidelines: | ||
|
||
- Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort. | ||
- Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. | ||
- Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored. | ||
- Please sign the `Contributor License Agreement (CLA)` when a pull request is opened. We cannot accept your pull request without this. Make sure you sign with the primary email address associated with your local / github account. | ||
|
||
## <a name="commit"></a> Webpack Contrib Commit Conventions | ||
|
||
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special | ||
format that includes a **type**, a **scope** and a **subject**: | ||
|
||
``` | ||
<type>(<scope>): <subject> | ||
<BLANK LINE> | ||
<body> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The **header** is mandatory and the **scope** of the header is optional. | ||
|
||
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier | ||
to read on GitHub as well as in various git tools. | ||
|
||
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. | ||
|
||
Examples: | ||
|
||
``` | ||
docs(readme): update install instructions | ||
``` | ||
|
||
``` | ||
fix: refer to the `entrypoint` instead of the first `module` | ||
``` | ||
|
||
### Revert | ||
|
||
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. | ||
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. | ||
|
||
### Type | ||
|
||
Must be one of the following: | ||
|
||
- **build**: Changes that affect the build system or external dependencies (example scopes: babel, npm) | ||
- **chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults) | ||
- **ci**: Changes to our CI configuration files and scripts (example scopes: circleci, travis) | ||
- **docs**: Documentation only changes (example scopes: readme, changelog) | ||
- **feat**: A new feature | ||
- **fix**: A bug fix | ||
- **perf**: A code change that improves performance | ||
- **refactor**: A code change that neither fixes a bug nor adds a feature | ||
- **revert**: Used when reverting a committed change | ||
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons) | ||
- **test**: Addition of or updates to Jest tests | ||
|
||
### Scope | ||
|
||
The scope is subjective & depends on the `type` see above. A good example would be a change to a particular class / module. | ||
|
||
### Subject | ||
|
||
The subject contains a succinct description of the change: | ||
|
||
- use the imperative, present tense: "change" not "changed" nor "changes" | ||
- don't capitalize the first letter | ||
- no dot (.) at the end | ||
|
||
### Body | ||
|
||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". | ||
The body should include the motivation for the change and contrast this with previous behavior. | ||
|
||
### Footer | ||
|
||
The footer should contain any information about **Breaking Changes** and is also the place to | ||
reference GitHub issues that this commit **Closes**. | ||
|
||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
|
||
Example | ||
|
||
``` | ||
BREAKING CHANGE: Updates to `Chunk.mapModules`. | ||
This release is not backwards compatible with `Webpack 2.x` due to breaking changes in webpack/webpack#4764 | ||
Migration: see webpack/webpack#5225 | ||
``` | ||
|
||
## Testing Your Pull Request | ||
|
||
You may have the need to test your changes in a real-world project or dependent | ||
module. Thankfully, Github provides a means to do this. Add a dependency to the | ||
`package.json` for such a project as follows: | ||
|
||
```json | ||
{ | ||
"devDependencies": { | ||
"schema-utils": "webpack-contrib/schema-utils#{id}/head" | ||
} | ||
} | ||
``` | ||
|
||
Where `{id}` is the # ID of your Pull Request. | ||
|
||
## Thanks | ||
|
||
For your interest, time, understanding, and for following this simple guide. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
open_collective: webpack |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<!-- | ||
ππ½ Need support, advice, or help? Don't open an issue! | ||
Head to StackOverflow or https://gitter.im/webpack/webpack. | ||
Hey there! | ||
You arrived at this template because you felt none of the other options | ||
matched the kind of issue you'd like to report. Please use this opportunity to | ||
tell us about your particular type of issue so we can try to accomodate | ||
similar issues in the future. | ||
PLEASE do note, if you're using this to report an issue already covered by the | ||
existing template types, your issue may be closed as invalid. Our issue | ||
templates contain fields that help us help you, and without that important | ||
info, we might as well be ice-skating uphill, carrying a wooly mammoth. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,50 @@ | ||
--- | ||
name: π Bug | ||
about: Report a Bug | ||
name: π Bug Report | ||
about: Something went awry and you'd like to tell us about it. | ||
--- | ||
|
||
<!-- βοΈ Briefly describe the issue you are experiencing. Tell us what you were trying to do and what happened instead. Remember, this is *not* the right place to ask general support questions. For that, please go to http://gitter.im/webpack/webpack or StackOverflow --> | ||
<!-- | ||
Issues are so π₯ | ||
### Details | ||
If you remove or skip this template, you'll make the πΌ sad and the mighty god | ||
of Github will appear and pile-drive the close button from a great height | ||
while making animal noises. | ||
<!-- βοΈ Describe in more detail the problem you have been experiencing (if necessary) --> | ||
ππ½ Need support, advice, or help? Don't open an issue! | ||
Head to StackOverflow or https://gitter.im/webpack/webpack. | ||
--> | ||
|
||
### Error (Logs|Stacks) | ||
- Operating System: | ||
- Node Version: | ||
- NPM Version: | ||
- webpack Version: | ||
- schema-utils Version: | ||
|
||
<!-- π Create a [gist](https://gist.github.com) which is a paste of your **full** logs, and link them here --> | ||
### Expected Behavior | ||
|
||
<!-- β οΈ Do **not** paste your full logs here (or at least fold them by using a `<details>{{ logs }}</details>` block), as it will make this issue long and hard to read! If you are reporting a bug, **always** include logs! --> | ||
<!-- Remove this section if not reporting a bug or modification request. --> | ||
|
||
### Reproduction (Code) | ||
### Actual Behavior | ||
|
||
<!-- β οΈ Please remember that, with sample code; it's easier to reproduce a bug and much faster to fix it --> | ||
<!-- Remove this section if not reporting a bug or modification request. --> | ||
|
||
<!-- π Please refer to a simple code example --> | ||
### Code | ||
|
||
```bash | ||
$ git clone https://github.com/<user>/<sample> | ||
```js | ||
// webpack.config.js | ||
// If your code blocks are over 20 lines, please paste a link to a gist | ||
// (https://gist.github.com). | ||
``` | ||
|
||
### Environment | ||
```js | ||
// additional code, HEY YO remove this block if you don't need it | ||
``` | ||
|
||
### How Do We Reproduce? | ||
|
||
<!-- π Please provide information about your current environment --> | ||
<!-- | ||
Remove this section if not reporting a bug. | ||
|OS|node|npm/yarn|package| | ||
|:-:|:--:|:-:|:------:| | ||
|[name][version]|[version]|[version]|[version]| | ||
If your webpack config is over 50 lines long, please provide a URL to a repo | ||
for your beefy π app that we can use to reproduce. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,28 @@ | ||
--- | ||
name: π Docs | ||
about: Report documentation related issues | ||
name: π Documentation | ||
about: Are the docs lacking or missing something? Do they need some new π₯ hotness? Tell us here. | ||
--- | ||
|
||
### Type | ||
<!-- | ||
Issues are so π₯ | ||
<!-- π Specify the type of issue by checking one of the provided checkboxes below and please deleted all others --> | ||
If you remove or skip this template, you'll make the πΌ sad and the mighty god | ||
of Github will appear and pile-drive the close button from a great height | ||
while making animal noises. | ||
- [ ] Other | ||
- [ ] Wrong | ||
- [ ] Unclear | ||
- [ ] Missing | ||
ππ½ Need support, advice, or help? Don't open an issue! | ||
Head to StackOverflow or https://gitter.im/webpack/webpack. | ||
--> | ||
|
||
### Details | ||
Documentation Is: | ||
|
||
<!-- βοΈ Briefly describe the issue you are experiencing. Tell us what you were trying to do (how you understood the documentation) and what happened instead --> | ||
<!-- Please place an x (no spaces!) in all [ ] that apply --> | ||
|
||
### Location | ||
- [ ] Missing | ||
- [ ] Needed | ||
- [ ] Confusing | ||
- [ ] Not Sure? | ||
|
||
<!-- π Select the area where the aforementioned issue is currently located --> | ||
### Please Explain in Detail... | ||
|
||
- [ ] README | ||
- [ ] LICENSE | ||
- [ ] CHANGELOG | ||
- [ ] ISSUE_TEMPLATE | ||
- [ ] BUG | ||
- [ ] DOCS | ||
- [ ] FEATURE | ||
- [ ] PULL_REQUEST_TEMPLATE | ||
### Your Proposal for Changes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,25 @@ | ||
--- | ||
name: π Feature | ||
about: Request a feature | ||
name: β¨ Feature Request | ||
about: Suggest an idea for this project | ||
--- | ||
|
||
### Proposal | ||
<!-- | ||
Issues are so π₯ | ||
<!-- βοΈ Briefly describe the feature you want to be added --> | ||
If you remove or skip this template, you'll make the πΌ sad and the mighty god | ||
of Github will appear and pile-drive the close button from a great height | ||
while making animal noises. | ||
### Use Case | ||
ππ½ Need support, advice, or help? Don't open an issue! | ||
Head to StackOverflow or https://gitter.im/webpack/webpack. | ||
--> | ||
|
||
<!-- βοΈ Describe in more detail the specific use case this feature addresses --> | ||
- Operating System: | ||
- Node Version: | ||
- NPM Version: | ||
- webpack Version: | ||
- schema-utils Version: | ||
|
||
### Implementation | ||
### Feature Proposal | ||
|
||
<!-- π Select one of the provided options --> | ||
|
||
- [ ] I'm open to work on this | ||
- [ ] I need help/mentorship | ||
- [ ] I'm unable to work on this | ||
|
||
<!-- βοΈ Briefly describe the feature implementation --> | ||
### Feature Use Case |
Oops, something went wrong.