Webpack-cli: docs: add section to test the CLI locally

Created on 24 Feb 2020  路  18Comments  路  Source: webpack/webpack-cli

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

Documentation Good First Contribution Help Wanted

Most helpful comment

I don't think we need this.

All 18 comments

@ematipico I would like to help on this one.

Go ahead!

@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.

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.)

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

PS: I have already setup the repo.

@adrijshikhar you can go ahead with this one.

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

Already working on it.

alright!

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

@nlok5923 Yes

Ok I am working on it

@ematipico please can you guide me with this issue

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?

Hi. Can I take up this issue?

I don't think we need this.

+1

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jbottigliero picture jbottigliero  路  5Comments

billyjanitsch picture billyjanitsch  路  3Comments

evenstensberg picture evenstensberg  路  5Comments

Pomax picture Pomax  路  3Comments

heyalbert picture heyalbert  路  3Comments