Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.36 KB

File metadata and controls

37 lines (30 loc) · 1.36 KB
summary Contribution workflow for this extension repository.
read_when
Before opening PRs or submitting local changes.
system4d
container compass engine fog
Contributor process and quality gates.
Small, validated, documented changes.
Branch -> implement -> check -> document -> review.
Process details may adjust with team scale.

Contributing

Workflow

  1. Create a focused branch.
  2. Run npm run docs:list and read matched docs before cross-cutting changes.
  3. Implement one scoped change.
  4. Run npm run check.
  5. Update docs/changelog where relevant.
  6. Open PR with concise rationale and validation output.

Standards

  • Keep diffs small and reviewable.
  • Preserve markdown frontmatter in generated docs.
  • Prefer explicit scripts over manual one-off commands.

Copier policy

  • Keep .copier-answers.yml in version control.
  • Do not edit .copier-answers.yml manually.
  • Run update/recopy from a clean destination repo (commit or stash pending changes first).
  • Use copier update --trust when .copier-answers.yml includes _commit and update is supported.
  • In non-interactive shells/CI, append --defaults to update/recopy.
  • Use copier recopy --trust when update is unavailable (for example local non-VCS source) or cannot reconcile cleanly.
  • After recopy, re-apply local deltas intentionally and run npm run check.