README: says a template is copied into a Postulo, a path the core rules out; and the repository has no licence #13

Open
opened 2026-10-01 10:48:15 +00:00 by tiagoagueda · 0 comments
Owner

Found on 2026-09-29 in a read-only review of postulo-templates at 01b8ae287, reading its README against the core's theme code (postulo 95348908d) and the wiki (de1f52467).

Related to #1.

The repository holds a 13-line README and nothing else. That it has no templates yet is already recorded in postulo/postulo#241 (open, item 6). This issue is about what that one does not cover: the README describes a way of using templates that the core does not have and says it never will, three other documents repeat or build on it, and there is no LICENSE for the first contribution to arrive under.

  • Where:
    • README.md:9-13: "A template pack is not a package: nothing installs it from a catalogue, nothing imports it, and a template is copied into a Postulo and edited there. What matters is which Postulo a template was written against, and that is said in each template".
    • README.md:3-5: "A curated selection of document templates for Postulo … in the theme format Postulo renders".
    • Core, CONTRIBUTING.md:379-380: "postulo-templates is not a package and carries no version at all, deliberately: a template pack is copied, not installed."
    • Wiki, Roadmap.md:95, under "Already built, as separate repositories … installed only if you want it": "A curated set of CV and letter templates". Core, docs/PLAN.md:196, lists it the same way.
    • No LICENSE file. postulo/postulo#279 (closed) noted this in passing, "so they are not lost", and nothing was filed here.
  • What happens: a template cannot be copied into an instance. documents/themes.py:28-38 allows two sources for a theme, shipped inside Postulo or inside an installed plugin, and says of the plugin route that it "is the only one"; BUILT_IN (documents/themes.py:118-121) is a fixed pair, and a plugin's theme arrives through themes.register (documents/themes.py:128) from a Theme the plugin declares, with a templates/ directory beside its package (plugins/themes.py:107, plugins/api.py:346-350). The wiki says the same: "There is no upload form for themes and there will not be one" (Writing-a-plugin.md:1011-1015). A file placed in an instance is offered by no picker. So whatever ships from here has to be a plugin package: installed, imported, with its own locale/, and versioned under the lockstep rule of postulo/postulo#186, which is the opposite of each clause in the README's second section. postulo/postulo#241 already asks for the content "as Themes".
  • Why it matters: a person who follows the Roadmap link looking for a CV template finds an empty repository described as built. A contributor has no format to follow, instructions that cannot be carried out, and no terms to contribute under; the core is AGPL-3.0-or-later and postulo-helloworld is MIT, so the licence here is a decision, not a default.
  • Fix:
    1. Decide what the repository is and say so in README.md: a feature plugin that declares Themes (then it is a package, it is installed, and it carries the version of the Postulo it is released beside), and until it has content, a placeholder.
    2. Remove "copied, not installed" from core's CONTRIBUTING.md:379-380, and move the row in the wiki's Roadmap.md:95 out of "Already built" until postulo/postulo#241 item 6 lands.
    3. Add a LICENSE.

Related to postulo/postulo#241, which asks for the content, a render test and CI; to postulo/postulo#186 (closed), where "no version, copied not installed" was decided; and to postulo/postulo#132 (closed), which ruled out themes from anywhere but Postulo and installed plugins.

Done when

  • README.md no longer says a template is copied into a Postulo, and states how a template from this repository reaches an instance in terms the core supports (a plugin's Theme), or that the repository is a placeholder.
  • LICENSE exists.
  • Core's CONTRIBUTING.md and the wiki's Roadmap.md agree with the README. There is no test suite here yet; when postulo/postulo#241 adds one, a test in it that registers the pack's themes through postulo.plugins.api is what holds the README to the code.
Found on 2026-09-29 in a read-only review of postulo-templates at 01b8ae287, reading its README against the core's theme code (postulo 95348908d) and the wiki (de1f52467). Related to #1. The repository holds a 13-line README and nothing else. That it has no templates yet is already recorded in postulo/postulo#241 (open, item 6). This issue is about what that one does not cover: the README describes a way of using templates that the core does not have and says it never will, three other documents repeat or build on it, and there is no `LICENSE` for the first contribution to arrive under. - **Where:** - `README.md:9-13`: "A template pack is not a package: nothing installs it from a catalogue, nothing imports it, and a template is copied into a Postulo and edited there. What matters is which Postulo a template was written against, and that is said in each template". - `README.md:3-5`: "A curated selection of document templates for Postulo … in the theme format Postulo renders". - Core, `CONTRIBUTING.md:379-380`: "`postulo-templates` is not a package and carries no version at all, deliberately: a template pack is copied, not installed." - Wiki, `Roadmap.md:95`, under "Already built, as separate repositories … installed only if you want it": "A curated set of CV and letter templates". Core, `docs/PLAN.md:196`, lists it the same way. - No `LICENSE` file. postulo/postulo#279 (closed) noted this in passing, "so they are not lost", and nothing was filed here. - **What happens:** a template cannot be copied into an instance. `documents/themes.py:28-38` allows two sources for a theme, shipped inside Postulo or inside an installed plugin, and says of the plugin route that it "is the only one"; `BUILT_IN` (`documents/themes.py:118-121`) is a fixed pair, and a plugin's theme arrives through `themes.register` (`documents/themes.py:128`) from a `Theme` the plugin declares, with a `templates/` directory beside its package (`plugins/themes.py:107`, `plugins/api.py:346-350`). The wiki says the same: "There is no upload form for themes and there will not be one" (`Writing-a-plugin.md:1011-1015`). A file placed in an instance is offered by no picker. So whatever ships from here has to be a plugin package: installed, imported, with its own `locale/`, and versioned under the lockstep rule of postulo/postulo#186, which is the opposite of each clause in the README's second section. postulo/postulo#241 already asks for the content "as `Theme`s". - **Why it matters:** a person who follows the Roadmap link looking for a CV template finds an empty repository described as built. A contributor has no format to follow, instructions that cannot be carried out, and no terms to contribute under; the core is AGPL-3.0-or-later and `postulo-helloworld` is MIT, so the licence here is a decision, not a default. - **Fix:** 1. Decide what the repository is and say so in `README.md`: a feature plugin that declares `Theme`s (then it is a package, it is installed, and it carries the version of the Postulo it is released beside), and until it has content, a placeholder. 2. Remove "copied, not installed" from core's `CONTRIBUTING.md:379-380`, and move the row in the wiki's `Roadmap.md:95` out of "Already built" until postulo/postulo#241 item 6 lands. 3. Add a `LICENSE`. Related to postulo/postulo#241, which asks for the content, a render test and CI; to postulo/postulo#186 (closed), where "no version, copied not installed" was decided; and to postulo/postulo#132 (closed), which ruled out themes from anywhere but Postulo and installed plugins. ## Done when - `README.md` no longer says a template is copied into a Postulo, and states how a template from this repository reaches an instance in terms the core supports (a plugin's `Theme`), or that the repository is a placeholder. - `LICENSE` exists. - Core's `CONTRIBUTING.md` and the wiki's `Roadmap.md` agree with the README. There is no test suite here yet; when postulo/postulo#241 adds one, a test in it that registers the pack's themes through `postulo.plugins.api` is what holds the README to the code.
tiagoagueda added this to the 0.6.0 milestone 2026-10-01 10:48:15 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
Postulo/postulo-templates#13
No description provided.