search

webpack / webpack-cli

Webpack's Command Line Interface
https://webpack.js.org/api/cli
MIT License
2.57k stars 603 forks source link

docs: add section to test the CLI locally #1264

Closed ematipico closed 4 years ago

ematipico commented 4 years ago

Creating a new section inside CONTRIBUTING.md that would help people to test the CLI locally.

Sometimes people use the command yarn link or npm link but I think there's a batter way to improve the experience.

We could create a new package called @webpack-cli/issue-repo ("name": "create-webpack-issue") which will be downloaded by people that wants to create a repo for an issue AND by people that are triaging the issue/

Inside the package.json of this template project, we should add relativeDeps which will be used by people that need to recreate the issue.

Calling the package like this will help us to integrate with scaffolding tools such as yarn create

snitin315 commented 4 years ago

@ematipico I would like to help on this one.

ematipico commented 4 years ago

Go ahead!

snitin315 commented 4 years ago

@ematipico can you explain this line a bit more people that wants to create a repo for an issue , or can provide an example case.

ematipico commented 4 years ago

Usually we ask people for a repo to reproduce the issue. This could be a time consuming problem. To alleviate the burden, we can create a yarn template (a la create-reacrt-app) with everything prepared (package.json, files, etc.)

adrijshikhar commented 4 years ago

@ematipico i would like to contribute on this issue. Can you assign it to me? Thanks

PS: I have already setup the repo.

snitin315 commented 4 years ago

@adrijshikhar you can go ahead with this one.

Parikshit-Hooda commented 4 years ago

Hi. Can I take up this issue? It seems @adrijshikhar is unresponsive.

adrijshikhar commented 4 years ago

Already working on it.

Parikshit-Hooda commented 4 years ago

alright!

nlok5923 commented 4 years ago

is this issue still open if yes can i work on it

snitin315 commented 4 years ago

@nlok5923 Yes

nlok5923 commented 4 years ago

Ok I am working on it

nlok5923 commented 4 years ago

@ematipico please can you guide me with this issue

adrijshikhar commented 4 years ago

According to what I have understood, the @webpack-cli/issue-repo package will help users to report bugs easily. It will provide a boilerplate to the users and with the help of relativeDeps, the dependencies will be pointed to the webpack-cli version, on which the user is facing a problem. Now with the basic structure of the template ready, the user can upload to GitHub and add the link to the repo in the issue itself. Correct me if I am wrong.

I also wanted to know what can be the bare minimum requirements in the issue repo?

Deepak-du commented 4 years ago

Hi. Can I take up this issue?

anshumanv commented 4 years ago

I don't think we need this.

snitin315 commented 4 years ago

+1

anshumanv commented 4 years ago

Closing, feel free to open a new issue if anyone faces any problem in testing.