Say plainly that this repo is a generated mirror - #27
Merged
Conversation
A newcomer landing here cannot tell that packages/ and pnpm-lock.yaml are copied from the monorepo by the release train, so a hand edit here looks reasonable and is silently overwritten by the next release. Name that at the top, and point contributions at the monorepo, while noting the workflows and release tags are genuinely owned here.
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.
Two people are working across these repos now, and nothing on this page tells a newcomer that most of the tree is generated. Someone can reasonably open this repo, fix something in
packages/, and have the next release quietly overwrite it.Adds a short note under the tagline: development happens in the monorepo,
packages/andpnpm-lock.yamlare copied from it verbatim by the release train, and PRs/issues belong on the monorepo. It also states what this repo genuinely does own (.github/workflows/, the release tags, the attestations), so the note does not read as "never touch anything here" and the workflow-only dependabot PRs still make sense.README.md is maintained in this repo rather than synced from the monorepo, so this note will not be clobbered: its text appears nowhere in the monorepo, and its history is hand-authored release commits.