Compare commits
9 Commits
integratio
...
main
Author | SHA1 | Date | |
---|---|---|---|
d9c0402981 | |||
21a8361174 | |||
39ec59a356 | |||
e33ee77db9 | |||
b913a983bd | |||
1e65aadda9 | |||
a00b6a8782 | |||
d381070c75 | |||
9cb1f5da1f |
42
DISCUSS.md
42
DISCUSS.md
@@ -1,42 +0,0 @@
|
||||
DISCUSSION – Areas, Structure, Ownership
|
||||
|
||||
Context
|
||||
- This repo hosts generic, foundational practices reusable across projects.
|
||||
- Areas: COMMON (shared practices), CTO (shared technical standards), COO (business ops), CCO (deferred; placeholder only).
|
||||
|
||||
Decisions Confirmed
|
||||
- Area directories are uppercase: COMMON, CTO, COO, CCO.
|
||||
- Shared practices and base guidance live under COMMON.
|
||||
- CCO is deferred for now; placeholder directory only.
|
||||
|
||||
Open Questions to Confirm
|
||||
- Naming conventions within areas
|
||||
- File naming: keep kebab-case (e.g., [COMMON/git-workflow.md](COMMON/git-workflow.md)) or use TitleCase?
|
||||
- Per-area `README.md` vs. `INDEX.md` expectations.
|
||||
- Scope boundaries
|
||||
- COMMON: include Git workflow, CI/bootstrap parity, templates (PR/issue), documentation style guide, ADR pattern, security/privacy baselines?
|
||||
- CTO: preferred tech stacks, language/runtime versions, container base image policy, local dev environment patterns (devcontainers/Make), testing strategy, quality bars?
|
||||
- COO: operating rhythm (cadences, ceremonies), roles/RACI, OKR/KPI templates, onboarding, procurement/vendor-lite guidance, documentation templates?
|
||||
- CCO: when in scope, include customer journey templates, support/SLA baselines, enablement playbooks, feedback loops? Any overlap rules with COO/CTO?
|
||||
- Consumers and audience
|
||||
- Internal only or some content public-facing? Any confidentiality/compliance constraints (esp. COO/CCO)?
|
||||
- Reuse strategy
|
||||
- Copy into new repos vs. reference centrally? Provide “adoption guides” per area? Offer minimal vs. advanced profiles?
|
||||
- Ownership & change control
|
||||
- CODEOWNERS per area? Who approves updates across COMMON/CTO/COO?
|
||||
- Labels and PR templates per area; contribution guidelines?
|
||||
- Document shape and standards
|
||||
- Prescriptive checklists vs. narrative guidance; include “10-minute quickstart” per area?
|
||||
- Standardize front‑matter, headers, and ADR structure?
|
||||
- Cross‑cutting policies
|
||||
- Where to maintain shared policies (security, privacy, accessibility) — under COMMON?
|
||||
- CI for docs
|
||||
- Keep current markdown/yaml linters repo‑wide; add link checker/spellcheck?
|
||||
- Migration of existing docs
|
||||
- Which existing files beyond Git workflow and CI bootstrap should move under COMMON now vs. later (e.g., proposals, questions, [RESUME.md](RESUME.md), [TODO.md](TODO.md))?
|
||||
|
||||
Proposed Next Steps (pending answers)
|
||||
- Seed per‑area README with scope, audiences, adoption guidance.
|
||||
- Create COMMON/templates/ for reusable checklists, PR/issue templates, ADRs.
|
||||
- Map/move additional shared docs into COMMON and update references.
|
||||
- Define CODEOWNERS and contribution norms per area.
|
@@ -1,31 +1,9 @@
|
||||
#!/usr/bin/env python3
|
||||
import os, sys
|
||||
import os, sys, yaml
|
||||
|
||||
def load_manifest(path):
|
||||
# Minimal YAML parser for our simple manifests:
|
||||
# keys: name (ignored), include: [..], modules: [..]
|
||||
data = {"include": [], "modules": []}
|
||||
key = None
|
||||
with open(path, 'r', encoding='utf-8') as f:
|
||||
for raw in f:
|
||||
line = raw.rstrip('\n')
|
||||
s = line.strip()
|
||||
if not s or s.startswith('#'):
|
||||
continue
|
||||
if s.startswith('include:'):
|
||||
key = 'include'
|
||||
continue
|
||||
if s.startswith('modules:'):
|
||||
key = 'modules'
|
||||
continue
|
||||
if s.startswith('name:'):
|
||||
key = None
|
||||
continue
|
||||
# list item under current key
|
||||
if key in ('include', 'modules') and s.startswith('- '):
|
||||
item = s[2:].strip()
|
||||
data[key].append(item)
|
||||
return data
|
||||
return yaml.safe_load(f)
|
||||
|
||||
def resolve(path, seen):
|
||||
m = load_manifest(path)
|
||||
@@ -50,7 +28,6 @@ def main():
|
||||
if not mods:
|
||||
print(f"No modules resolved from {manifest}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if out_path != '-':
|
||||
os.makedirs(os.path.dirname(out_path), exist_ok=True)
|
||||
def read(p):
|
||||
with open(p, 'r', encoding='utf-8') as f:
|
||||
|
@@ -31,11 +31,7 @@ build_manifest() {
|
||||
# Write on host to avoid ownership issues; container prints to stdout.
|
||||
TMP_OUT=$(mktemp)
|
||||
trap '[[ -n "${TMP_OUT:-}" ]] && rm -f "$TMP_OUT"' EXIT
|
||||
ci_run "python3 scripts/prompt_build.py '$manifest' -" >"$TMP_OUT" || true
|
||||
# Fallback: if container produced no output, run on host
|
||||
if [[ ! -s "$TMP_OUT" ]]; then
|
||||
python3 scripts/prompt_build.py "$manifest" - >"$TMP_OUT"
|
||||
fi
|
||||
ci_run "python3 scripts/prompt_build.py '$manifest' -" >"$TMP_OUT"
|
||||
mkdir -p "$(dirname "$out")"
|
||||
mv "$TMP_OUT" "$out"
|
||||
}
|
||||
|
Reference in New Issue
Block a user