root
/
webpack
mirror of https://github.com/webpack/webpack.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

CONTRIBUTING: add nice paragraph from @jhnns

This commit is contained in:
Jonathan Dumaine 2015-03-25 21:50:35 +07:00
parent f6dd1450c5
commit 40d284e130
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -9,25 +9,33 @@ that include your webpack.config.js and relevant files are more likely to receiv
**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.** **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: If you have created your own loader/plugin please incude it on the relevant
documentation pages:
[List of loaders](http://webpack.github.io/docs/list-of-loaders.html) [List of loaders](http://webpack.github.io/docs/list-of-loaders.html)
[List of plugins](http://webpack.github.io/docs/list-of-plugins.html) [List of plugins](http://webpack.github.io/docs/list-of-plugins.html)
### Documentation ### Documentation
Webpack is insanely feature rich and documentation is a huge time sink. We greatly appreciate any Webpack is insanely feature rich and documentation is a huge time sink. We
time spent fixing typos or clarifying sections in the documentation. greatly appreciate any time spent fixing typos or clarifying sections in the
documentation.
## Submitting Changes ## Submitting Changes
* Push to your fork and submit a pull request. From opening a bug report to creating a pull request: every contribution is
* Wait for feedback. We may suggest some changes or improvements or alternatives. 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.
Some things that will increase the chance that your pull request is accepted: Some things that will increase the chance that your pull request is accepted:
* Write tests. * Write tests
* Follow our coding style. * Follow the existing coding style
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)