LG Webpack Contribution Guide

A (WIP) guide for first time contributors to the webpack ecosystem.

Process

You too can start contributing to open source in just a few easy steps...

1. Familiarize yourself generally with contributing to Open Source. If you've never contributed or worked on a big project, look over some of the resources on how to do that. The Free Code Camp link is particularly jucy and coprehensive. Contributing to opensource for the first time can be overwhelming. Don't panic! We're here for you.

   • Free Code Camp: How to Contribute to Open Source
   • Open Source Guides: How to Contribute to Open Source
   • First Timers Only
   • Webpack's Contributing Documentation

2. Familiarize yourself with how Webpack works. If you've never worked with webpack do the Getting Started tutorial so you can understand what it's like to work with. If you already know what webpack does, now it's time to get under the hood. It's way easier to contribute when you have an idea of what's actually happening in the project you're working on.

   • Clone and install webpack core
   • Watch Sean Larkin's conversation with LG folk on how webpack & plugins work.
   • ARTICLE: The Contributors Guide to Webpack:
     • Part 1: A(n) (eco)system overview
     • Part 2: Diving Deeper: Tapable, plugins and design patterns!
     • Part 3: Building the Dependency Graph
   • VIDEO: Everything is a plugin! Mastering webpack from the inside out: this video is great and helped me understand the relevance of plugins. Links mentioned in the talk:
     • github: Artsy Webpack Tour
     • github: Everything is a Plugin
   • VIDEO: Sean's Twitch stream from 10/9 where he goes over how webpack works and makes contributions.
   • ARTICLE: The new plugin system (week 22–23)
   • VIDEO: From start to finish: A 20-ish minute contribution to webpack
   • RELEVANT SUB LIBRARIES
     • tappable

3. Grab an issue from webpack core or look over our projects board to find something to work on.

   • Our Project Board
   • D0 - 1st Contribution
   • D1 - Easy Difficulty
   • X5 - Work Required/ Help Needed

4. Ways to get help while you're working:

   • message Rachel & the webpack channel on Learner's Guild's Community slack.
   • comment on the issue and tag [??] and ask for clarifications or feedback.
   • chat with folks on Webpack's internal slack for help.

Schedule

All are welcome at standup! For apprentice phase folks please:

• Submit your work plan on Monday morning
• Attend daily 1pm Standup
• Attend retros on Friday

TODOS & NOTES

• upgrade the plugins api to match changes in webpack 4.0.0-alpha.
  • ** 12/12: apparently many of these have been done. Search and find any additional to contribute to.
  • where can we reference the api or find what to change?
  • CONTEXT: issue - webpack 4.0.0-alpha.0 feedback
  • feat(tapable): upgrade Single|Multi|DynamicEntryPlugin to tapable v1 #6078
  • Improve PluginEnvironment helper to support tapable's hooks #6079
• find libraries within the webpack ecosystem to upgrade to es6 syntax.
• update the plugin documentation to for webpack2 to be as comprehensive as webpack1

Expanding Wepack's Availability and Ease of Contribution

• Make webpack issues easy to find
  • Up-For-Grabs.net
  • issueHub
  • TODO evaluate other links in the Contributing to open source in general section here
  • Optimize issue tags for searching.
• Create resources that help people understand the library.
  • video series?
  • monthly Q&A?