Skip to content

Commit f4b8785

Browse files
authored
Merge pull request webpack#5012 from webpack/TheLarkInn-patch-1
Changing readme voice to align with comm direction
2 parents 3da4f3e + c2c5d73 commit f4b8785

1 file changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -241,20 +241,43 @@ friendly** by using hashes.
241241

242242
<h2 align="center">Contributing</h2>
243243

244-
Most of the time, if webpack is not working correctly for you it is a simple configuration issue.
244+
**We want contributing to webpack to be fun, enjoyable, and educational for anyone, and everyone.** We have a [vibrant ecosystem](https://medium.com/webpack/contributors-guide/home) that spans beyond this single repo. We welcome you to check out any of the repositories in [our organization](http://github.com/webpack) or [webpack-contrib organization](http://github.com/webpack-contrib) which houses all of our loaders and plugins.
245245

246-
If you are still having difficulty after looking over your configuration carefully, please post
247-
a question to [StackOverflow with the webpack tag](https://stackoverflow.com/tags/webpack). Questions
248-
that include your webpack.config.js and relevant files are more likely to receive responses.
246+
Contributions go far beyond pull requests and commits. Although we love giving you the opportunity to put your stamp on webpack, we also are thrilled to receive a variety of other contributions including:
249247

250-
If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.
248+
* [Documentation](https://github.com/webpack/webpack.js.org) updates, enhancements, designs, or bugfixes
249+
* Spelling or grammar fixes
250+
* README.md corrections or redesigns
251+
* Adding unit, or functional tests
252+
* Triaging GitHub issues -- especially determining whether an issue still persists or is reproducible.
253+
* [Searching #webpack on twitter](https://twitter.com/search?q=webpack) and helping someone else who needs help
254+
* Teaching others how to contribute to one of the many webpack repo's!
255+
* [Blogging, speaking about, or creating tutorials](https://github.com/webpack-contrib/awesome-webpack) about one of webpack's many features.
256+
* Helping others in our webpack [gitter channel](https://gitter.im/webpack/webpack).
251257

252-
If you create a loader or plugin, please consider open sourcing it, putting it
253-
on npm and following the `x-loader`, `x-webpack-plugin` convention.
258+
If you are worried or don't know where to start, you can **always** reach out to [Sean Larkin (@TheLarkInn) on Twitter](https://twitter.com/thelarkinn) or simply submit an issue and a maintainer can help give you guidance!
254259

255-
You are also welcome to correct any spelling mistakes or any language issues.
260+
We have also started a series on our [Medium Publication](https://medium.com/webpack) called [The Contributor's Guide to webpack](https://medium.com/webpack/contributors-guide/home). We welcome you to read it and post any questions or responses if you still need help.
256261

257-
If you want to discuss something or just need help, [here is our Gitter room](https://gitter.im/webpack/webpack).
262+
_Looking to speak about webpack?_ We'd **love** to review your talk abstract/CFP! You can email it to webpack [at] opencollective [dot] com and we can give pointers or tips!!!
263+
264+
<h3 align="center">Creating your own plugins and loaders</h3>
265+
If you create a loader or plugin, we would <3 for you to open source it, and put it on npm. We follow the `x-loader`, `x-webpack-plugin` naming convention.
266+
267+
<h2 align="center">Support</h2>
268+
269+
We consider webpack to be a low-level tool used not only individuals but also layered beneath other awesome tools. Because of it's flexibility, webpack isn't always the _easiest_ entry-level solution, however we do believe it is the most powerful. That said, we're always looking for ways improve and simplify the tool without compromising functionality. If you have any ideas on ways to accomplish this, we're all ears!
270+
271+
If you're just getting started, take a look at [our new docs and concepts page](https://webpack.js.org/concepts/). This has a high level overview that is great for beginners!!
272+
273+
If you want to discuss something or just need help, [here is our Gitter room](https://gitter.im/webpack/webpack) where there are always individuals looking to help out!
274+
275+
If you are still having difficulty, we would love for you to post
276+
a question to [StackOverflow with the webpack tag](https://stackoverflow.com/tags/webpack). It is much easier to answer questions that include your webpack.config.js and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
277+
278+
If you are twitter savvy you can tweet #webpack with your question and someone should be able to reach out and help also.
279+
280+
If you have discovered a 🐜 or have a feature suggestion, feel free to create an issue on Github.
258281

259282
### License
260283

0 commit comments

Comments
 (0)