Update docs to clarify common workflow regarding npm link of forked repo

Open
#590 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
nodejs
Domain
documentation

Research direction

No file or test is named. Start by reviewing the project documentation and the linked workflow discussion, then verify the npm link and fork workflow described; done means the common workflow and the proposed --from-fork behavior are clearly documented.

Written by the indexing model from the issue text.

Description

I'm wondering if there's a simpler way to achieve some of the workflow advantages mentioned in https://github.com/ds300/patch-package/issues/15

Normally, when I create a PR for a dependency, I use npm link to test out the fix.

I had a fixed library still linked and I wondered if creating a patch from my changes would "just work" but the changes were not in the patch.

I can create a git patch file from my fix commit but then in order to apply it inside the node_modules, I'd guess that I'd have to edit every path mentioned in it. What if this was done programatically with a flag --from-fork=../my-forked-repo?

Dominant language
TypeScript
Stars
11.2k
Forks
325
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 ds300/patch-package

All issues in ds300/patch-package

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.