webpack/CONTRIBUTING.md

2.1 KiB

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 still having difficulty after looking over your configuration carefully, please post a question to StackOverflow with the webpack tag. Questions that include your webpack.config.js and relevant files are more likely to receive responses.

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.

Contributing to the webpack ecosystem

If you have created your own loader/plugin please include it on the relevant documentation pages:

List of loaders or awesome-webpack List of plugins or awesome-webpack

Setup

git clone https://github.com/webpack/webpack.git
cd webpack
npm install -g yarn
yarn install
yarn link
yarn link webpack

To run the entire test suite use:

yarn 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:

Documentation

webpack is insanely feature rich and documentation is a huge time sink. We greatly appreciate any time spent fixing typos or clarifying sections in the documentation.

Discussions

Gitters is only for small questions. To discuss in long a subject, please send on gitters a link to your forum or blog.