- Delete CODE_OF_CONDUCT.md (generic boilerplate) - Simplify README.md, link to ra-h.app/docs as primary - Simplify CONTRIBUTING.md - Fix bug_report.md (was referencing PostgreSQL, uses SQLite) - Gut bloated PR template - Simplify feature_request.md - Update docs/README.md to point to website - Update docs/9_open-source.md
1.3 KiB
1.3 KiB
Contributing
This is the open source mirror of a private repository. Features are developed privately and synced here.
Full docs: ra-h.app/docs
What We Accept
- Bug fixes – especially ones you've encountered
- Doc improvements – typos, clarifications, examples
- Small enhancements – that don't require architectural changes
For larger features, open an issue first. Major features are typically implemented in the private repo and synced here.
Setup
git clone https://github.com/bradwmorris/ra-h_os.git
cd ra-h_os
npm install
npm rebuild better-sqlite3
scripts/dev/bootstrap-local.sh
npm run dev
Before Submitting a PR
npm run build
npm run type-check
npm run lint
All three must pass.
Code Style
- TypeScript with strict types (avoid
any) - Functional React components
- Tailwind CSS for styling
- Database operations through service layer (
/src/services/database/)
What Happens to Your Contribution
- We review and merge here
- If applicable, we port to the private repo
- Future syncs won't overwrite your contribution
License
By contributing, you agree your work is licensed under MIT.
Questions?
Check ra-h.app/docs or open an issue.