Skip to content

Commit ec068ca

Browse files
committed
Improve CONTRIBUTING.md
1 parent beadd8e commit ec068ca

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
21
# Contributing
32

3+
From opening a bug report to creating a pull request: every contribution is
4+
appreciated and welcome. If you're planning to implement a new feature or change
5+
the api please create an issue first. This way we can ensure that your precious
6+
work is not in vain.
7+
8+
## Issues
9+
410
Most of the time, if webpack is not working correctly for you it is a simple configuration issue.
511

612
If you are still having difficulty after looking over your configuration carefully, please post
@@ -9,25 +15,31 @@ that include your webpack.config.js and relevant files are more likely to receiv
915

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

18+
## Contributing to the webpack ecosystem
19+
1220
If you have created your own loader/plugin please include it on the relevant
1321
documentation pages:
1422

15-
[List of loaders](https://webpack.github.io/docs/list-of-loaders.html)
23+
[List of loaders](https://webpack.github.io/docs/list-of-loaders.html)
1624
[List of plugins](https://webpack.github.io/docs/list-of-plugins.html)
1725

18-
### Documentation
26+
## Setup
1927

20-
webpack is insanely feature rich and documentation is a huge time sink. We
21-
greatly appreciate any time spent fixing typos or clarifying sections in the
22-
documentation.
28+
```bash
29+
git clone https://github.com/webpack/webpack.git
30+
cd webpack
31+
npm install
32+
npm link
33+
npm link webpack
34+
```
2335

36+
To run the entire test suite use:
2437

25-
## Submitting Changes
38+
```bash
39+
npm test
40+
```
2641

27-
From opening a bug report to creating a pull request: every contribution is
28-
appreciated and welcome. If you're planning to implement a new feature or change
29-
the api please create an issue first. This way we can ensure that your precious
30-
work is not in vain.
42+
## Submitting Changes
3143

3244
After getting some feedback, push to your fork and submit a pull request. We
3345
may suggest some changes or improvements or alternatives, but for small changes
@@ -38,3 +50,9 @@ Some things that will increase the chance that your pull request is accepted:
3850
* Write tests
3951
* Follow the existing coding style
4052
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
53+
54+
## Documentation
55+
56+
webpack is insanely feature rich and documentation is a huge time sink. We
57+
greatly appreciate any time spent fixing typos or clarifying sections in the
58+
documentation.

0 commit comments

Comments
 (0)