diff --git a/.editorconfig b/.editorconfig index 181aeeb..9f89f36 100644 --- a/.editorconfig +++ b/.editorconfig @@ -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 diff --git a/.eslintignore b/.eslintignore index 07e6e47..a90d9cf 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1 +1,4 @@ +/coverage +/dist /node_modules +/test/fixtures diff --git a/.eslintrc.js b/.eslintrc.js index 7e0659d..095ce2a 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -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'], }; diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 13c6864..a3cedd7 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -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. \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..e8386c0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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) + +## 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. + +## 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. + +## 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. + +## 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. + +## 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**: + +``` +(): + + + +