Skip to content

chore: repo standards compliance audit — June 2026#15

Merged
sparshsam merged 1 commit into
mainfrom
chore/repo-standards-audit-20260615
Jun 17, 2026
Merged

chore: repo standards compliance audit — June 2026#15
sparshsam merged 1 commit into
mainfrom
chore/repo-standards-audit-20260615

Conversation

@sparshsam

Copy link
Copy Markdown
Owner

Audit Summary

Full repo-standards-compliance audit against ecosystem-standards (repository-structure, readme-standard, architecture-standard, documentation-standard, security-standard, repo-maturity-model).

Maturity assessed: Prototype (Stage 1) — aligned with README self-declaration.

Findings & Fixes

# Finding Severity Fix Applied
1 package.json license mismatch — field says "MIT", LICENSE file is AGPL-3.0 🔴 Critical Changed to "AGPL-3.0-only"
2 README duplicated content — a full duplicate copy (CRLF) was appended at EOF 🔴 Critical Removed duplicate
3 .env.example missing required comment header 🟡 Minor Added: "Copy this file to .env..."
4 No .github/ISSUE_TEMPLATE/ directory 🟡 Minor Added bug_report.md + feature_request.md
5 No .github/PULL_REQUEST_TEMPLATE.md 🟡 Minor Added ecosystem-standard template
6 Duplicate architecture docs — both docs/architecture.md and docs/ARCHITECTURE.md existed 🟡 Minor Removed lowercase duplicate, kept uppercase
7 README Quick Links referenced docs/architecture.md (deleted) 🟡 Minor Updated to docs/ARCHITECTURE.md

Items Already Compliant ✅

Standard Status
README.md present
LICENSE (AGPL-3.0)
.gitignore (includes .env*)
.env.example present ✅ (fixed header)
CHANGELOG.md
CONTRIBUTING.md
SECURITY.md
CODE_OF_CONDUCT.md
SUPPORT.md
AGENTS.md
ROADMAP.md
docs/ARCHITECTURE.md
.github/workflows/ci.yml
.github/dependabot.yml
vercel.json (security headers)
GitHub topics (19 tags)
Description set
README language (restrained, no marketing)
README maturity statement
README required sections (9 of 9)

Not Required at Prototype Stage

  • VERSIONING.md (required at Maintained)
  • CITATION.cff (required at Publication-ready)
  • .zenodo.json (required at Publication-ready)
  • docs/privacy-model.md (required at Publication-ready)
  • docs/research-note.md (required at Publication-ready)
  • docs/maintenance.md (required at Canonical)
  • ARCHITECTURE.md at root (docs/ suffices)

Comparison with Peer Repos

  • chess-by-sparsh: Maintained maturity, has ROADMAP.md, ARCHITECTURE.md, full .github templates — well aligned.
  • openscrabble: Maintained maturity, has ARCHITECTURE.md, CODE_OF_CONDUCT.md, SUPPORT.md, simpler structure.
  • openproof: Prototype maturity, already has more governance docs (rfcs/ directory, multiple specs) than is typical for this stage — strong documentation culture.

Files Modified

  • README.md — removed duplicate content, fixed architecture link
  • package.json — fixed license field
  • .env.example — added comment header
  • docs/architecture.md — deleted (duplicate of docs/ARCHITECTURE.md)
  • .github/ISSUE_TEMPLATE/bug_report.md — created
  • .github/ISSUE_TEMPLATE/feature_request.md — created
  • .github/PULL_REQUEST_TEMPLATE.md — created

- Fix package.json license field: MIT → AGPL-3.0-only
- Fix README duplicated content (remove duplicate copy at EOF)
- Add required comment header to .env.example
- Create .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md
- Create .github/PULL_REQUEST_TEMPLATE.md
- Remove duplicate docs/architecture.md (docs/ARCHITECTURE.md kept)
- Fix README Quick Links architecture reference
@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openproof Ready Ready Preview, Comment Jun 17, 2026 10:46pm

@sparshsam sparshsam merged commit 2eb9f03 into main Jun 17, 2026
2 of 3 checks passed
@sparshsam sparshsam deleted the chore/repo-standards-audit-20260615 branch June 17, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant