49 lines
1.1 KiB
Markdown
49 lines
1.1 KiB
Markdown
# Development Process (RA-OS)
|
|
|
|
This repo is the open-source build of RA-H. Keep changes focused, reviewable, and easy to sync upstream.
|
|
|
|
## Branching
|
|
|
|
- Create a feature branch off `main` for all changes.
|
|
- Use short, descriptive names: `docs-...`, `fix-...`, `feat-...`.
|
|
- Avoid direct commits to `main`.
|
|
|
|
## Local Setup
|
|
|
|
```bash
|
|
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
|
|
```
|
|
|
|
## Dev Loop
|
|
|
|
1. Reproduce or define the change.
|
|
2. Implement in a small, isolated diff.
|
|
3. Run checks (see below).
|
|
4. Update docs if behavior or UX changes.
|
|
|
|
## Checks
|
|
|
|
```bash
|
|
npm run type-check
|
|
npm run lint
|
|
npm run build
|
|
```
|
|
|
|
## PR Checklist
|
|
|
|
- Clear description of the change and why it matters.
|
|
- Screenshots or GIFs for UI changes.
|
|
- Docs updated if the public-facing behavior changed.
|
|
- Checks pass locally.
|
|
|
|
## Sync Policy (Private Upstream)
|
|
|
|
- Changes land in `ra-h_os` first.
|
|
- If a change should exist in the private repo, it will be ported upstream.
|
|
- Public contributions will not be overwritten by syncs.
|