webpack/webpack.js.org

Contribute - Codebase Overview / Contribution Guide

Open

#1,824 opened on Feb 6, 2018

View on GitHub
 (14 comments) (1 reaction) (1 assignee)MDX (3,436 forks)github user discovery
ContributeEnhancementHelp WantedIn Planning

Repository metrics

Stars
 (2,268 stars)
PR merge metrics
 (PR metrics pending)

Description

After a great suggestion from a contributor, I've decided to open this issue to any contributors who would like to create a section completely devoted to contributing to the webpack source code, and an overview of the code.

Both links show a great bulleted list of things that should be mentioned in this adaptation for webpack. I'm going to assign myself as advisor/mentor to this for contributors who would like to take a piece of one of these tasks. Breaking it down we'd need to:

  • Section for contributing built into docs arch.
  • Section for code overview built into docs arch.
  • Start adding actual content for the pages/sections.

Contributor guide

Research direction
Research the webpack source code structure and existing documentation to create a contribution guide and codebase overview. Focus on organizing the documentation architecture and writing content.
Tech stack
None
Domain
developer experiencedocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85