Background
The README already contains detailed setup and orchestration documentation, and it links to CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, and the MIT LICENSE near the bottom. However, for a new OSS user or contributor arriving from GitHub, the project does not make its contribution, support, and license paths visible early enough.
This is related to #391, which adds GitHub issue/PR templates. The README should also make the OSS contribution flow feel complete and trustworthy.
Proposed Changes
Add a small OSS-facing README polish pass without rewriting the full document:
-
Add badges near the top where practical, such as:
- CI status
- npm package/version, if available
- Node.js 24+
- MIT license
- PRs welcome / Code of Conduct
-
Add a short contribution/support note near the intro or Quickstart:
- contributions are welcome
- bug reports should use the GitHub issue templates
- setup/orchestration bug reports should include
gh-symphony doctor --bundle
- security reports should follow
SECURITY.md
-
Keep the existing detailed CLI/operator documentation intact.
-
Preserve and, if useful, lightly improve the existing Community and security / License links near the bottom.
Affected Files
| File |
Change |
Scope |
README.md |
Add OSS-facing badges and contribution/support guidance |
Documentation |
.github/ISSUE_TEMPLATE/config.yml |
Optional: cross-link README / contributing / security paths if implemented with #391 |
Documentation / community health |
Acceptance Criteria
- README makes it clear near the top that GitHub Symphony is an MIT-licensed OSS project.
- New contributors can quickly find
CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, and LICENSE.
- Bug report guidance points users toward GitHub issue templates and recommends attaching
gh-symphony doctor --bundle for setup/orchestration failures.
- Existing detailed CLI documentation remains intact; the change does not become a broad README rewrite.
- All added links and badges resolve correctly.
Notes
Avoid overstating maturity with unverified claims such as "enterprise-grade" or "production-ready" unless the README already supports those claims. The goal is OSS polish and discoverability, not marketing copy inflation.
Background
The README already contains detailed setup and orchestration documentation, and it links to
CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md, and the MITLICENSEnear the bottom. However, for a new OSS user or contributor arriving from GitHub, the project does not make its contribution, support, and license paths visible early enough.This is related to #391, which adds GitHub issue/PR templates. The README should also make the OSS contribution flow feel complete and trustworthy.
Proposed Changes
Add a small OSS-facing README polish pass without rewriting the full document:
Add badges near the top where practical, such as:
Add a short contribution/support note near the intro or Quickstart:
gh-symphony doctor --bundleSECURITY.mdKeep the existing detailed CLI/operator documentation intact.
Preserve and, if useful, lightly improve the existing Community and security / License links near the bottom.
Affected Files
README.md.github/ISSUE_TEMPLATE/config.ymlAcceptance Criteria
CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md, andLICENSE.gh-symphony doctor --bundlefor setup/orchestration failures.Notes
Avoid overstating maturity with unverified claims such as "enterprise-grade" or "production-ready" unless the README already supports those claims. The goal is OSS polish and discoverability, not marketing copy inflation.