CoolFace
Datasetpublic

LevelUp2x/e-zeropoint-blueprint-data

sourceHugging Faceupdated 1y agoView on Hugging Face
0likes15downloads
CONTRIBUTING.md40 linesDownload Raw Back to root
1# Contributing2 3Thank you for contributing to the Nova R&D blueprint. Please read AGENTS.md first.4 5## Quick Start6- Fork/clone the repo and create a branch from `develop`:7  - `git checkout develop && git pull`8  - `git checkout -b feature/<short-purpose>`9- Keep commits small and frequent; use Conventional Commits.10- Open a PR to `develop` with a clear summary and links to ADRs.11 12## Branching Model13- `main`: stable, tagged releases only.14- `develop`: integration branch; all PRs land here first.15- `feature/*`: focused changes; rebase on `develop` as needed.16- `release/*`: prep releases; docs, versioning, final checks.17- `hotfix/*`: urgent fixes off `main`.18 19## Commits & PRs20- Format: `type(scope): subject` (types: feat, fix, docs, chore, refactor, test).21- Body: what/why, notable tradeoffs, references to ADRs/issues, affected paths.22- PR checklist:23  - Receipts updated (`13_receipts/`), indices linked, templates followed24  - Evals/Metrics touched documented (`08_evals/`, `06_metrics/`)25  - Screenshots/snippets for major doc changes26 27## Documentation & Tracking28- Use `04_decisions/ADR-TEMPLATE.md` for decisions; one per decision.29- Use `05_experiments/EXPERIMENT_TEMPLATE.md`; ensure reproducibility.30- Append logs to `03_research_logs/` (timestamped). Do not rewrite.31- Validate JSON receipts against `13_receipts/SCHEMA.json` when applicable.32 33## Style34- Markdown: `#`/`##` headings, `-` lists, ~100‑col wrap, 2‑space indent.35- Use code fences for commands/paths.36 37## Reviews38- Two approvals preferred; at least one reviewer with context.39- Keep PRs under ~300 lines of diff when possible; split otherwise.40