Webpack-cli: docs: Adding readme.md in folders

[himanshu010]

Do you want to request a feature or report a bug?

What is the current behavior?
The readme file does not have the file system describing the locations of files. Sometimes it is very tedious to find a particular file, therefore projects like this needs a fully descriptive file system.

If the current behavior is a bug, please provide the steps to reproduce.

What is the expected behavior?
The readme file should contain file system.

If this is a feature request, what is motivation or use case for changing the behavior?

Please paste the results of webpack-cli info here, and mention other relevant information such as programming language.

I would Like to work on this issue

[ematipico]

Could you help me here and explain me what you'd like to see? An example or some details

[himanshu010]

it is something like this :

[maria99williams]

Yeah I think that it would be great for someone like me as I am new to open source. I am looking forward to contribute to webpack.

[anshumanv]

+1 for this as this could provide a general overview of the code.

[ematipico]

Which section would you think makes sense to have it? The contribution section?

[snitin315]

Yes Contribution .

[himanshu010]

Which section would you think makes sense to have it? The contribution section?

Yeah, with a subheading of "Folder Structure"

[ematipico]

Thank you! Feel free to make a PR!

[rishabh3112]

@himanshu010 I didn't get the exact benefit it would bring to the first time contributors as we have individual READMEs in each package which explains their functionalities.

Instead I would like to propose to add READMEs in the folders which you think you faced issues to understand, something like this:
https://github.com/webpack/webpack/blob/master/examples/README.md

[himanshu010]

okay, I would work on this.

[adrijshikhar]

Is this issue still open? I have been using webpack for quite a while now and I absolutely love it. I feel like this will be a nice starting point. I will go through the existing PRs and post a final conclusion if that suits or if anyone else has an idea of what has to be done here, please guide me through that.

[snitin315]

I think we already have Readme files at appropriate places.
/cc @webpack/cli-team

[alexander-akait]

Yep, we don't need readme at each directory

[snitin315]

Lets close it then 👍🏻

[snitin315]

@adrijshikhar maybe you can check help with some other newly created issues.

[adrijshikhar]

Yeah sure. Thanks 😀