docs: update process and contributor guidance
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
# RA-OS Agent Workflow (Open Source)
|
||||
|
||||
This file is the source of truth for AI agents and contributors working in this repository.
|
||||
|
||||
## Scope
|
||||
|
||||
- This workflow applies to `ra-h_os` only.
|
||||
- Do not require private-repo docs, handoffs, or backlog files to complete work here.
|
||||
|
||||
## Working Rules
|
||||
|
||||
1. Start from `main` and create a branch:
|
||||
- `feat/<short-name>`
|
||||
- `fix/<short-name>`
|
||||
- `docs/<short-name>`
|
||||
2. Keep changes small and reviewable.
|
||||
3. If behavior changes, update docs in the same PR.
|
||||
4. Do not commit directly to `main`.
|
||||
|
||||
## Standard Dev Loop
|
||||
|
||||
1. Reproduce/define the problem.
|
||||
2. Implement the minimal correct change.
|
||||
3. Run local checks.
|
||||
4. Update docs and screenshots if needed.
|
||||
5. Open PR with clear summary and test notes.
|
||||
|
||||
## Required Checks
|
||||
|
||||
```bash
|
||||
npm run type-check
|
||||
npm run lint
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Docs Map
|
||||
|
||||
- `README.md` - product overview + quick start
|
||||
- `docs/README.md` - docs index
|
||||
- `docs/4_tools-and-guides.md` - MCP tools + guides
|
||||
- `docs/6_ui.md` - UI behavior
|
||||
- `docs/8_mcp.md` - MCP setup and troubleshooting
|
||||
- `docs/development/process.md` - contributor process
|
||||
- `docs/development/docs-process.md` - docs maintenance process
|
||||
|
||||
## Upstream Relationship
|
||||
|
||||
- `ra-h_os` accepts direct contributions.
|
||||
- Maintainers may sync relevant changes between public and private repos.
|
||||
- Public contributions should remain attributable and not be overwritten.
|
||||
|
||||
Reference in New Issue
Block a user