Skip to content

chore: move community health files to .github/#20

Merged
igorlg merged 1 commit into
mainfrom
chore/move-community-files-to-github
May 21, 2026
Merged

chore: move community health files to .github/#20
igorlg merged 1 commit into
mainfrom
chore/move-community-files-to-github

Conversation

@igorlg

@igorlg igorlg commented May 21, 2026

Copy link
Copy Markdown
Owner

Summary

Moves three community health files from the repository root to .github/, the GitHub-blessed location:

CONTRIBUTING.md     → .github/CONTRIBUTING.md
CODE_OF_CONDUCT.md  → .github/CODE_OF_CONDUCT.md
SECURITY.md         → .github/SECURITY.md

GitHub auto-discovers them there with full feature parity to root: the 'Contribute' tab, the 'Security' tab + private vulnerability reporting page, and the Community Standards detection all find them.

Files that stay at root (and why)

File Reason
README.md pyproject.toml: readme reads it; PyPI metadata; GitHub home page; 37 cross-refs
CHANGELOG.md release-please writes here every release (changelog-path in release-please-config.json)
LICENSE License-detection tools hardcode root path
NOTICE Apache-2.0 NOTICE convention is at root

Net root reduction: 5 .md → 2 .md (README, CHANGELOG).

Reference updates

File Change
README.md:144 [CONTRIBUTING.md](CONTRIBUTING.md)(.github/CONTRIBUTING.md)
docs/CI.md:297, 703 ../CONTRIBUTING.md../.github/CONTRIBUTING.md
.github/workflows/release.yml:115 comment text updated
openspec/specs/ci-infrastructure/spec.md:86 scenario reference updated

Sibling links inside the moved files (CONTRIBUTING ↔ SECURITY ↔ CODE_OF_CONDUCT) remain valid: all three are now siblings in .github/, so the relative paths still resolve.

Deliberately not changed

  • openspec/changes/archive/** — archived openspec changes are historical records. References to root-level files describe the state at the time of authoring; rewriting them would falsify the project history.
  • Inline prose mentions of "CONTRIBUTING.md" without link syntax (e.g. docs/CI.md:261, 695) — descriptive references, not broken links.

Verification

  • just openspec-validate clean
  • just lint (ruff + format + cfn-lint) clean
  • Grep across active files (excluding archive/, .venv/) finds zero lingering root-relative refs to the three moved files

Post-merge

After merge, you can verify GitHub picked them up correctly at:

  • https://github.com/igorlg/cfn-handler/community (Community Standards page)
  • The 'Contribute' link should appear in the repo sidebar (was already there since CONTRIBUTING was at root)
  • 'Security' tab should still link to the SECURITY.md content

Move CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md from the
repository root to .github/, the GitHub-blessed location for
community health files. GitHub auto-discovers them there with full
feature parity:
  * 'Contribute' tab and PR-opening flow find .github/CONTRIBUTING.md
  * 'Security' tab and the private vulnerability reporting page find
    .github/SECURITY.md
  * Code of Conduct detection finds .github/CODE_OF_CONDUCT.md

Files that stay at root and why:
  * README.md      — pyproject.toml's 'readme' field reads it; PyPI
                     and GitHub home page convention
  * CHANGELOG.md   — release-please writes here every release
                     (changelog-path in release-please-config.json)
  * LICENSE        — license-detection tools hardcode root path
  * NOTICE         — Apache-2.0 NOTICE convention is at root

Reference updates:
  * README.md:144 — link target → .github/CONTRIBUTING.md
  * docs/CI.md:297, 703 — relative-path links → ../.github/CONTRIBUTING.md
  * .github/workflows/release.yml:115 — comment text updated
  * openspec/specs/ci-infrastructure/spec.md:86 — scenario reference
    updated to .github/CONTRIBUTING.md

Sibling links inside the moved files (CONTRIBUTING.md → SECURITY.md
and → CODE_OF_CONDUCT.md) remain valid: all three are now siblings
in .github/, so the relative paths still resolve.

Archived openspec changes under openspec/changes/archive/ are
deliberately NOT updated; they are historical records of changes as
they existed at the time of authoring. Rewriting them would falsify
the project history.

Verified: openspec-validate clean (only ci-release-please-app-auth
active); ruff + cfn-lint clean; grep finds zero lingering
root-relative refs to the moved files in active files.
@igorlg igorlg merged commit 5c927e4 into main May 21, 2026
16 checks passed
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