Add design docs; update README/PLAN
This commit is contained in:
parent
ce3a3da81f
commit
86b0c4d251
5 changed files with 553 additions and 0 deletions
|
|
@ -20,6 +20,14 @@ Early design. See [`PLAN.md`](PLAN.md) for the full analysis and roadmap (in Spa
|
|||
- **Free/libre.** Copyleft software, open data formats, multilingual from day one.
|
||||
- **Layered.** Inventory -> Offer -> Local sharing -> Web of trust. Each layer is useful on its own.
|
||||
|
||||
## Conventions
|
||||
|
||||
**English is the project language for all code.** Identifiers, class/field/column names, code comments, commit messages, branch names, and technical documents (data model, schemas) are written in English, without exception. This keeps the project contributable by anyone, anywhere.
|
||||
|
||||
- User-facing strings are **never hardcoded** — they go through i18n (the app itself is multilingual by design).
|
||||
- Planning and discussion documents may be written in Spanish (e.g. `PLAN.md`, `docs/design/data-notes.md`); technical specs that feed code are in English (e.g. `docs/design/data-model.md`).
|
||||
- Database schema changes ship as versioned Drift migrations (`drift_schemas/`), one new version per change, never editing a released version. See `docs/design/data-model.md` §5.
|
||||
|
||||
## License
|
||||
|
||||
Software: copyleft (AGPL/GPLv3, TBD). Docs & assets under CC-BY-SA where noted.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue