Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Better documentation of patch and patch-commit #1852

Closed
1 of 2 tasks
mrtnbroder opened this issue Sep 21, 2020 · 3 comments
Closed
1 of 2 tasks

[Feature] Better documentation of patch and patch-commit #1852

mrtnbroder opened this issue Sep 21, 2020 · 3 comments
Labels
documentation This issue or pull request is about the documentation enhancement New feature or request good first issue Good for newcomers

Comments

@mrtnbroder
Copy link

mrtnbroder commented Sep 21, 2020

  • I'd be willing to implement this feature
  • This feature can already be implemented through a plugin

Describe the user story

I was looking into patch and how it works, but the docs didnt give much info. The CLI also didnt. I had to look around to get an idea of it. I thought it worked similar like patch-package. However, it works differently.

Describe the solution you'd like

I was looking for the docs to make a PR with a better documenation of it but couldn't find it. Maybe its on a CMS or something.

Can we add more info about patch and patch-commit and how it works? (e.g. there is no mentioning of adding the patch: protocol to the package.json file)

@mrtnbroder mrtnbroder added the enhancement New feature or request label Sep 21, 2020
@arcanis
Copy link
Member

arcanis commented Sep 21, 2020

Doc is currently here https://yarnpkg.com/features/protocols#patch. However, it would be worth to improve the CLI documentation for patch and patch-commit, help appreciated 😃

@arcanis arcanis added the good first issue Good for newcomers label Sep 21, 2020
@sanyamgandhak
Copy link

Hi there ,
Please assign it to me

@arcanis
Copy link
Member

arcanis commented Oct 14, 2022

We don't assign issues. Feel free to open PRs if you see a clear improvement.

@merceyz merceyz added the documentation This issue or pull request is about the documentation label Oct 14, 2022
@arcanis arcanis closed this as completed Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request is about the documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants