Improve open-source adoption and maintenance paths#6
Merged
Conversation
The remaining polish work turns the template from a private-ready scaffold into something easier for outside users to evaluate, fork, configure, and maintain. It adds conservative metadata initialization, contributor issue and PR surfaces, dependency automation, hosted-demo/release guidance, backend contract documentation, and an explicit accessibility/E2E maturity path without expanding the dependency stack. Constraint: Item 1 was already merged on main before this branch; this commit covers the remaining open-source readiness items. Constraint: No release tag was created; release docs only describe the tag workflow for maintainers. Rejected: Add Playwright or axe as a new dependency now | no-dependency smoke/docs checks keep this polish slice low-risk and consistent with the current script-based verification model. Confidence: high Scope-risk: moderate Directive: Replace the docs-only e2e contract with real browser automation once the project accepts a browser test dependency and maintenance path. Tested: node scripts/init-template.mjs --help Tested: init-template preview and --write against a temporary root Tested: npx eslint scripts/init-template.mjs scripts/e2e-smoke.mjs Tested: npm run smoke:e2e Tested: npm run smoke:a11y Tested: npm audit --omit=dev --registry=https://registry.npmjs.org Tested: npm run verify Not-tested: GitHub-hosted CI and Pages deployment after push Co-authored-by: OmX <omx@oh-my-codex.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The remaining polish work turns the template from a private-ready scaffold into something easier for outside users to evaluate, fork, configure, and maintain. It adds conservative metadata initialization, contributor issue and PR surfaces, dependency automation, hosted-demo/release guidance, backend contract documentation, and an explicit accessibility/E2E maturity path without expanding the dependency stack.
Constraint: Item 1 was already merged on main before this branch; this commit covers the remaining open-source readiness items.
Constraint: No release tag was created; release docs only describe the tag workflow for maintainers.
Rejected: Add Playwright or axe as a new dependency now | no-dependency smoke/docs checks keep this polish slice low-risk and consistent with the current script-based verification model.
Confidence: high
Scope-risk: moderate
Directive: Replace the docs-only e2e contract with real browser automation once the project accepts a browser test dependency and maintenance path.
Tested: node scripts/init-template.mjs --help
Tested: init-template preview and --write against a temporary root
Tested: npx eslint scripts/init-template.mjs scripts/e2e-smoke.mjs
Tested: npm run smoke:e2e
Tested: npm run smoke:a11y
Tested: npm audit --omit=dev --registry=https://registry.npmjs.org
Tested: npm run verify
Not-tested: GitHub-hosted CI and Pages deployment after push