liberusoftware / liberusoftware/documentation

MODULES.md section 30's definition of done is circular as a promotion gate

Open Beginner friendly
#21 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

architecture/MODULES.md §30's definition of done is used as the gate for deciding whether a path package becomes its own repository. One of its bullets requires:

the independent GitHub repository, README, CI workflow, generated coverage report, release tag, and tested-host compatibility evidence

Repository creation cannot be gated on already having a repository. As written, §30 can never be satisfied for a module that does not yet exist as a repo, which is precisely the case it is being consulted for.

How it was worked around downstream

ecommerce-laravel splits §30 at the point the repository exists:

  • Promotion gate — everything the monorepo can prove: no App\ dependency, architecture tests green, the suite runs without a host, persistence contained, contracts versioned, coverage at its floor, no cross-boundary edit in the last N commits.
  • Release gate — §30 in full, now answerable: repository, README, the three workflows, coverage report, tag, compatibility evidence, runbooks.

Written up at MODULE_DEVELOPMENT.md §6.

Ask

Split §30 upstream the same way, or state which subset is the promotion gate. Every product that reaches this point will otherwise invent its own split, and they will not agree.

Found while auditing ecommerce-laravel against the standards.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read architecture/MODULES.md §30 first, then compare the downstream split described in docs/MODULE_DEVELOPMENT.md §6. Update the upstream documentation so the promotion gate is answerable before a repository exists and the release gate covers repository-level evidence. Done means the two stages and their evidence are stated without a circular requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, laravel
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.