Webpack.js.org: Contribute - Codebase Overview / Contribution Guide

[TheLarkInn]

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.

• [ ] Codebase Overview - https://reactjs.org/docs/how-to-contribute.html
• [ ] Contribution Guide - https://reactjs.org/docs/codebase-overview.html

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.

[iamclaytonray]

I shall help 😄

[samundrak]

Hope to see this soon on webpack website :+1:
seems links on checkbox are exchanged @TheLarkInn

[skipjack]

Please add these pages to the __Contribute__ section, which already exists. You can create a subgroup(s) in the __Contribute__ section if necessary using the group key in each page's YAML frontmatter. This will cause a set of pages to be grouped in the sidebar on the left.

[iamclaytonray]

I'm not sure what the timeline is for this. I can help out some in the next 2(ish) weeks until a contract of mine is finished, and then I can spend a lot more time on this. @skipjack @TheLarkInn - is that okay? I'm happy to pass this off to someone who has more time and contribute to something else in the future.

@skipjack - Will do. Thanks for advising me!

[TheLarkInn]

@iamclaytonray this is more then okay! This is not a release blocking set of documentation, but is still pretty important! So I think it's best for anyone involved in this thread to do the following:

• Pick one piece (that is small enough to chip off in nor more then an hours worth of work) that you want to work on.
• Create an issue for that piece, tag the original issue here with it. (ill tie it up once its tagged).
• Work on it when you can.
• Rinse, repeat.

[iamclaytonray]

Cool. Thanks for your understanding! Will revisit this later when I get some more work done and decide which portion I'd like to tackle 😄

[s1iqbal]

Ill start working on it too!

[iamclaytonray]

I'll tackle contributing docs. @s1iqbal @TheLarkInn

[iamclaytonray]

Hey @TheLarkInn @skipjack - Finally caught up a bit and working on this. It seems as if each sub-section is still located in the same Contribute section, on the same page. Just so I have this correct, that is okay, right? How To Contribute, Codebase Overview, etc are all supposed to be on the same page?

That's what I am doing now. If I misunderstood, I can just move things around as you guys see fit. 😄

[skipjack]

@iamclaytonray you can break things out into multiple pages if it feels like it’s getting long. We can use the group key in the YAML front matter to group the pages within the __Contribute___ section as it discusses contributing to more than just the core repo.

That said, we can also discus this more once you’ve submitted a PR. Sometimes it’s easiest to focus on a solid story/well-written content and then re-organize after the fact.

[iamclaytonray]

Should I be using content from the current webpack/webpack CONTRIBUTING.md or writing my own content, and then iterate with the reviewer(s)? Just thought of that. I've been writing content myself but I suppose it would make more sense to use what's already there.

[iamclaytonray]

@TheLarkInn @skipjack

[skipjack]

@iamclaytonray if you think parts of the CONTRIBUTING.md file are useful then yes you should probably include that content or at least make sure the same topics are covered. One of the tougher things when writing docs is to maintain a consistent voice and flow so if you think things should be re-worded, then by all means do so.

That said, we should try to avoid duplicate documentation. So, once you've put something comprehensive together, maybe the CONTRIBUTING.md file over in webpack/webpack should be simplified and link out to the different parts of this new group of pages you're working on.

[strongSoda]

Hey there, I would like to contribute too @TheLarkInn.