docs: improve README for community contribution - #591
Open
tomymaritano wants to merge 2 commits into
Open
Conversation
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL. Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
|
Warning Review limit reachedNext included review available in 56 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
tomymaritano
marked this pull request as ready for review
August 24, 2026 17:19
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
2 participants
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
Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.
package.json(pnpm install,pnpm dev, desktop-only filter). Notes thatpnpm devis Turbo and also starts other workspacedevscripts, and thatpnpm testexcludesstorage-sqlite.develop; conventional commits; plugins/themes live in satellitedripnex/plugin-*anddripnex/theme-*repos, not this monorepo.Also updates
CONTRIBUTING.md(it still pointed at the oldreadideclone URL and told people to PRmain) and makes.github/CONTRIBUTING.mda short pointer to the root guide.Type of Change
Related Issues
None.
Checklist
pnpm test) — docs-only; not runpnpm build) — docs-only; not rundevelopbranch (notmain)Screenshots
Not applicable (markdown only).