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

Add guidelines around when to use peerDependencies vs. dependencies #117

Open
mcmire opened this issue Nov 26, 2024 · 0 comments
Open

Add guidelines around when to use peerDependencies vs. dependencies #117

mcmire opened this issue Nov 26, 2024 · 0 comments
Assignees

Comments

@mcmire
Copy link
Contributor

mcmire commented Nov 26, 2024

While maintaining Wallet Framework packages, we have found that controller dependencies and type-only dependencies frequently get miscategorized. It would be good to have a resource we can point people to whenever confusion arises.

Acceptance Criteria

  • A document exists which explains:
    • Why peerDependencies exists and what it does
    • Situations in which filing a dependency under devDependencies + peerDependencies is desired over dependencies (e.g. controllers)
    • Situations in which it is not appropriate to file a dependency under devDependencies + peerDependencies (e.g. type-only dependencies)
    • When and how to bump peerDependencies in a monorepo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant