2015-03-25 06:57:09 +01:00
# Contributing
2016-05-28 18:08:06 +02:00
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
2018-08-01 17:53:18 +02:00
Most of the time, if webpack is not working correctly for you, it is a simple configuration issue.
2015-03-25 06:57:09 +01:00
If you are still having difficulty after looking over your configuration carefully, please post
a question to [StackOverflow with the webpack tag ](http://stackoverflow.com/tags/webpack ). Questions
2018-02-24 12:28:07 +01:00
that include your webpack.config.js, relevant files, and the full error message are more likely to receive responses.
2015-03-25 06:57:09 +01:00
2018-02-24 00:22:37 +01:00
**If you have discovered a bug or have a feature suggestion, please [create an issue on GitHub ](https://github.com/webpack/webpack/issues/new ).**
2015-03-25 06:57:09 +01:00
2018-02-24 12:28:07 +01:00
Do you want to fix an issue? Look at the issues with a tag of [X5: work required (PR / Help Wanted) ](https://github.com/webpack/webpack/labels/X5%3A%20work%20required%20%28PR%20%2F%20Help%20Wanted%29 ). Each issue should be tagged with a difficulty tag -
2018-03-05 23:33:38 +01:00
- D0: My First Commit (Contribution Difficulty)
- D1: Easy (Contribution Difficulty)
- D2: Medium (Contribution Difficulty)
- D3: Hard (Contribution Difficulty)
2018-02-24 12:28:07 +01:00
2016-05-28 18:08:06 +02:00
## Contributing to the webpack ecosystem
2018-02-24 12:28:07 +01:00
If you have created your own loader/plugin please include it on the relevant documentation pages:
2015-03-25 06:57:09 +01:00
2018-02-24 12:28:07 +01:00
- [List of loaders ](https://webpack.js.org/loaders/ ) or [awesome-webpack ](https://github.com/webpack-contrib/awesome-webpack#loaders )
- [List of plugins ](https://webpack.js.org/plugins ) or [awesome-webpack ](https://github.com/webpack-contrib/awesome-webpack#webpack-plugins )
2015-03-25 06:57:09 +01:00
2016-05-28 18:08:06 +02:00
## Setup
2015-03-25 06:57:09 +01:00
2018-03-24 19:44:11 +01:00
[Setup your local webpack repository ](_SETUP.md )
2015-03-25 06:57:09 +01:00
2016-05-28 18:08:06 +02:00
## Submitting Changes
2015-03-25 15:50:35 +01:00
2018-08-01 17:53:18 +02:00
After getting some feedbacks, push to your fork and submit a pull request. We
2015-03-25 15:50:35 +01:00
may suggest some changes or improvements or alternatives, but for small changes
your pull request should be accepted quickly.
2015-03-25 06:57:09 +01:00
2018-08-01 17:53:18 +02:00
Something that will increase the chance that your pull request is accepted:
2015-03-25 06:57:09 +01:00
2016-12-27 20:45:01 +01:00
* [Write tests ](./test/README.md )
2015-03-25 15:50:35 +01:00
* Follow the existing coding style
2015-03-25 06:57:09 +01:00
* Write a [good commit message ](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html )
2016-05-28 18:08:06 +02:00
## 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
2018-02-24 12:28:07 +01:00
documentation. [See a list of issues with the documentation tag. ](https://github.com/webpack/webpack/labels/documentation )
2018-01-02 12:32:35 +01:00
## Discussions
2018-02-18 16:16:12 +01:00
Gitter is only for small questions. To discuss a subject in detail, please send a link to your forum or blog in the Gitter chat.