webpack/CONTRIBUTING.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

2015-03-25 13:57:09 +08:00
# Contributing
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](http://stackoverflow.com/tags/webpack). 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.**
If you have created your own loader/plugin please incude it on the relevant
documentation pages:
2015-03-25 13:57:09 +08:00
[List of loaders](http://webpack.github.io/docs/list-of-loaders.html)
[List of plugins](http://webpack.github.io/docs/list-of-plugins.html)
### 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.
2015-03-25 13:57:09 +08:00
## Submitting Changes
From opening a bug report to creating a pull request: every contribution is
appreciated and welcome. If you're planing 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.
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.
2015-03-25 13:57:09 +08:00
Some things that will increase the chance that your pull request is accepted:
* Write tests
* Follow the existing coding style
2015-03-25 13:57:09 +08:00
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)