README.md is Innacurate

Open
#22 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript, webpack
Domain
documentation

Research direction

Start in README.md at the installation guidance and compare its Webpack statement with the linked Webpack 5 release documentation. Update the inaccurate statement to reflect that automatic Node.js polyfills were removed and external polyfills may be required; done means the README no longer claims Webpack provides them automatically.

Written by the indexing model from the issue text.

Description

https://github.com/browserify/path-browserify#install

The statement about Webpack including node.js polyfill code is no longer accurate as of Webpack 5, per this documentation. Some packages now require external polyfills like this one even when using Webpack if they are using the newest version.

Dominant language
JavaScript
Stars
192
Forks
54
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from browserify/path-browserify

All issues in browserify/path-browserify

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.