liberusoftware / liberusoftware/documentation

THEMES.md section 3.2 asks for an ADR and migration plan to gitignore /themes — here it is

Open
#20 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

standards/THEMES.md §3.2 states:

the current decision, matching /modules, is not to add /themes to .gitignore

restated in §20's definition of done, and changeable "only through an ADR and migration plan".

ecommerce-laravel is going the other way for both directories, and §3.2 names the instrument for doing so, so this issue is the other half of it.

The decision downstream

During the path phase a module's code is committed to the host, because that is where it lives. At promotion the .gitignore flips per package, its files leave the host tree, and Composer becomes the only source.

Recorded as ADR 0010, with the migration plan §3.2 asks for at MIGRATION_PLAN.md.

The two directories are decided together because §3.2 cites /modules as its own precedent — deciding them separately would break the symmetry the clause rests on.

The observation behind it

boilerplate-laravel tracks 726 files under modules/ while installing the same code from VCS, and guards the duplication with git diff --exit-code --stat -- modules themes in release.yml. That guard exists solely to police a duplication that need not exist. Filed separately against boilerplate-laravel as a question rather than an assertion — it may be monorepo residue rather than intended vendoring.

Ask

Confirm whether §3.2's tracked-directory policy is a fleet-wide requirement or a boilerplate-laravel default that products may vary. If the former, this ADR is a genuine deviation and should be recorded as such upstream; if the latter, §3.2 is worth rewording, since it currently reads as binding.

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

Start with standards/THEMES.md §3.2, then read ADR 0010 and docs/MIGRATION_PLAN.md to compare the documented tracked-directory policy with the downstream decision. Review boilerplate-laravel's release.yml guard and determine whether the policy is fleet-wide or product-specific; done means the policy is confirmed and the standard is updated or the deviation is recorded upstream.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, laravel
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.