generated from coulomb/repo-seed
Replace stale repo-seed template README with a real one
Some checks are pending
ci / validate-registry (push) Waiting to run
Some checks are pending
ci / validate-registry (push) Waiting to run
Written from SCOPE.md/INTENT.md and direct source inspection. Requested during reuse-surface REUSE-WP-0017-T05 review follow-up. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
41
README.md
41
README.md
@@ -1,3 +1,40 @@
|
||||
# repo-seed
|
||||
# open-reuse
|
||||
|
||||
A git repository template to bootstrap coulomb projects from.
|
||||
*Managed continuity for valuable open-source integrations.*
|
||||
|
||||
Pragmatically-created integrations with open-source software — a reused
|
||||
component, an adapted service, an extracted module — become long-term
|
||||
dependencies on upstream evolution once they prove valuable. `open-reuse`
|
||||
turns those integrations into structured, maintainable, explicitly-owned
|
||||
assets instead of letting them degrade into undocumented, silently-breaking
|
||||
liabilities. The goal is not merely reuse, but **sustainable reuse under
|
||||
change**.
|
||||
|
||||
Every integration is analyzed, classified by reuse mode, given clear
|
||||
boundaries and interfaces, and tracked with an explicit update loop against
|
||||
its upstream.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
open-reuse validate
|
||||
open-reuse validate path/to/thing.integration.yaml --root .
|
||||
```
|
||||
|
||||
`validate` checks integration definitions (`registry/integrations/*.integration.yaml`)
|
||||
against `schemas/integration.schema.yaml` and the registry index
|
||||
(`registry/indexes/integrations.yaml`).
|
||||
|
||||
## Getting oriented
|
||||
|
||||
- **Intent and problem statement:** `INTENT.md`
|
||||
- **Scope and boundaries:** `SCOPE.md`
|
||||
- **Product requirements:** `ProductRequirementsDocument.md`
|
||||
- **Integration entry template:** `templates/integration-entry.template.yaml`
|
||||
- **CLI source:** `open_reuse/cli.py`, `open_reuse/registry.py`, `open_reuse/validate.py`
|
||||
|
||||
## In scope
|
||||
|
||||
Integration analysis docs, registry, and workplans; reuse-mode
|
||||
classification and continuity policies; State Hub progress and decisions.
|
||||
See `SCOPE.md` for the full in/out-of-scope breakdown.
|
||||
|
||||
Reference in New Issue
Block a user