0001. Record architecture decisions
Questi contenuti non sono ancora disponibili nella tua lingua.
- Status: accepted
- Date: 2026-10-26
Context
Section titled “Context”GuestCraft is meant to be modified by people who were not in the room when it was designed: contributors, agencies, companies that self-host it. The technical analysis (docs/GuestCraft-Technical-Analysis.pdf) explains the reference architecture, but it was a long document in Italian when this decision was taken, and it cannot record the small decisions made while building.
Decision
Section titled “Decision”Every decision that constrains future code gets an Architecture Decision Record in docs/adr, numbered, in English, following 0000-template.md. An ADR is short: context, decision, consequences, alternatives. A decision changes through a new ADR that supersedes the old one; accepted ADRs are not rewritten, except to fix typos or to add the “superseded by” link.
A pull request that contradicts an accepted ADR must either follow it or add the superseding ADR in the same pull request.
Consequences
Section titled “Consequences”Reviewers can point to a written rule instead of an opinion, and newcomers can learn why the code looks the way it does. Writing an ADR costs a few minutes; it is not required for choices that the linters or the structure document already settle.
Alternatives considered
Section titled “Alternatives considered”- Only the technical analysis. Too long to update for every decision, and at the time not written in the project’s working language.
- Decisions in issues or chat. Not versioned with the code and hard to find.