🪄 feat: use symbolic link for README.md and packages/vitest-preview/README.md#11
Merged
🪄 feat: use symbolic link for README.md and packages/vitest-preview/README.md#11
README.md and packages/vitest-preview/README.md#11Conversation
✅ Deploy Preview for vitest-preview canceled.
|
nvh95
changed the title
README.md and packages/vitest-preview/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary/ Motivation (TLDR;)
We are using monorepo for this project. The package
vitest-previewstays atpackages/vitest-previewand has it ownpackages/vitest-preview/README.md(to display on npmjs.com).However, we want users to see that file as well when they first access https://github.com/nvh95/vitest-preview. That means we need to duplicate
README.mdat both locations:packages/vitest-preview/README.mdREADME.mdThis raises a problem with maintenance, we need to manually update the other file when making changes to one file. This is annoying. But luckily, thanks to symbolic link, this issue can be resolved.
Chores
packages/vitest-preview/README.mdtoREADME.md