Skip to content
Pauta4.5.0

Repository documents

Start from the template. adl-desktop-app-template carries an example of every file on this page, filled in for a placeholder app, ExampleApp. scripts/rename.sh <AppName> <package> renames it to yours.

Rules on this page 10
IDLevelRule
REPO-01MUST
README.md is a landing page of about 200 lines: logo, badges, a one-paragraph pitch, the hero screenshot, highlights, install, build, command line, config folder, license. Detail lives on the website.
REPO-02MUST
CHANGELOG.md follows Keep a Changelog 1.1 and SemVer: an ## [Unreleased] section with Added / Changed / Fixed / Removed, and each entry opens with a bold one-line summary written for users.
REPO-03MUST
LICENSE is MIT, “Copyright (c) 2026 Adrián Arturo De León Saldivar”.
REPO-04MUST
NOTICE gives the app name, the copyright, “licensed under the MIT License”, then every bundled third-party component with its license (Inter is OFL, AtlantaFX is MIT, OpenJFX is GPLv2+CPE…). It ships inside the installers too.
REPO-05MUST
AGENTS.md holds the operational rules for coding agents: essential commands, worktree-per-task, the change checklist. It is not a changelog. A short CLAUDE.md points to it.
REPO-06MUST
CONTRIBUTING.md says how to build, test, format, and open a PR.
REPO-07MUST
docs/ holds architecture.md, conventions.md, testing.md, gotchas.md, release.md, building-and-packaging.md and decisions/ (ADRs).
REPO-08MAY
TODO.md holds the open list, kept in the same PR as the change.
REPO-09MUST
.github/ISSUE_TEMPLATE/bug_report.yml is an issue form whose field ids (environment, report) the in-app Report a Problem fills.
REPO-10MUST
branding/ holds the source SVG of the icon. The PNG, ICNS and ICO generated from it sit beside it or in packaging/.
  • REPO-01 MUST README.md is a landing page of about 200 lines: logo, badges, a one-paragraph pitch, the hero screenshot, highlights, install, build, command line, config folder, license. Detail lives on the website.
    • Check (code): README.md is near 200 lines and has those parts, with links to the website for the rest.
    • Reference: Editora README.md.
  • REPO-02 MUST CHANGELOG.md follows Keep a Changelog 1.1 and SemVer: an ## [Unreleased] section with Added / Changed / Fixed / Removed, and each entry opens with a bold one-line summary written for users.
    • Check (code): the file names Keep a Changelog and Semantic Versioning, starts with ## [Unreleased], and every entry starts with - **.
    • Reference: Editora CHANGELOG.md.
  • REPO-03 MUST LICENSE is MIT, “Copyright (c) 2026 Adrián Arturo De León Saldivar”.
    • Check (code): LICENSE opens with MIT License and that copyright line.
    • Reference: Editora LICENSE.
  • REPO-04 MUST NOTICE gives the app name, the copyright, “licensed under the MIT License”, then every bundled third-party component with its license (Inter is OFL, AtlantaFX is MIT, OpenJFX is GPLv2+CPE…). It ships inside the installers too.
    • Check (test): a test fails when a runtime dependency in pom.xml has no NOTICE entry, and another when LICENSE and NOTICE are not packaged.
    • Reference: Editora NOTICE, NoticeCoverageTest, BuildHygieneTest.
  • REPO-05 MUST AGENTS.md holds the operational rules for coding agents: essential commands, worktree-per-task, the change checklist. It is not a changelog. A short CLAUDE.md points to it.
    • Check (code): AGENTS.md has sections for commands, worktrees and the change checklist; CLAUDE.md is a few lines that send the reader to AGENTS.md.
    • Reference: Editora AGENTS.md, CLAUDE.md.
  • REPO-06 MUST CONTRIBUTING.md says how to build, test, format, and open a PR.
    • Check (code): CONTRIBUTING.md names the build, test and format commands and the PR step.
    • Reference: Editora CONTRIBUTING.md.
  • REPO-07 MUST docs/ holds architecture.md, conventions.md, testing.md, gotchas.md, release.md, building-and-packaging.md and decisions/ (ADRs).
    • Check (code): each of those paths exists under docs/.
    • Reference: Editora docs/.
  • REPO-08 MAY TODO.md holds the open list, kept in the same PR as the change.
    • Check (code): TODO.md exists at the root.
    • Reference: Editora TODO.md.
  • REPO-09 MUST .github/ISSUE_TEMPLATE/bug_report.yml is an issue form whose field ids (environment, report) the in-app Report a Problem fills.
  • REPO-10 MUST branding/ holds the source SVG of the icon. The PNG, ICNS and ICO generated from it sit beside it or in packaging/.
Editora's repository root on GitHub: branding, docs, AGENTS.md, CHANGELOG.md, CLAUDE.md, CONTRIBUTING.md, LICENSE, NOTICE, README.md and TODO.md, with the About sidebar
Editora's repository root: every file on this page, with the homepage, Readme, MIT license and Contributing links GitHub derives from them.
[![CI](https://github.com/adriandeleon/<App>/actions/workflows/ci.yml/badge.svg)](…/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/adriandeleon/<App>)](…/releases/latest)
[![License: MIT](https://img.shields.io/github/license/adriandeleon/<App>)](LICENSE)
![Java](https://img.shields.io/badge/Java-25%2B-orange?logo=openjdk&logoColor=white)
![JavaFX](https://img.shields.io/badge/JavaFX-27%2B-1e90ff)
![Platforms](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey)
[![Pauta](https://img.shields.io/badge/Pauta-4.2.0%20%C2%B7%20Core-5b8def)](<homepage>/docs/pauta/)
[![Stars](https://img.shields.io/github/stars/adriandeleon/<App>?style=flat)](…/stargazers)
The top of Editora's README on GitHub: logo, title, the badge row, the one-paragraph pitch, the website links and the hero screenshot
The top of Editora's README: logo, badges in this order, a two-sentence pitch, links to the website, then the hero screenshot.

The Pauta badge names the edition and the conformance, in green 2ea043 for Complete, blue 5b8def for Core and amber d29922 for Partial (where it reads “Working toward”), and links to the app’s Pauta conformance docs page; a test holds it to pauta.version and the computed conformance (Conformance).

The hero screenshot is a <picture> with a dark srcset under prefers-color-scheme: dark, so GitHub shows the screenshot that matches the reader’s theme. Screenshots are taken at 2× by a headless harness so they can be retaken after any UI change. The README states that the app is built with the help of AI coding tools.

Pauta 4.5.0 · · Changelog · This page in the latest edition