docs: add maintainer handoff artifacts (MAINTAINERS, CODEOWNERS, RELEASING, CHANGELOG, maintainer's guide)#175
docs: add maintainer handoff artifacts (MAINTAINERS, CODEOWNERS, RELEASING, CHANGELOG, maintainer's guide)#175adiadd wants to merge 2 commits into
Conversation
…ASING, CHANGELOG, maintainer's guide)
There was a problem hiding this comment.
Pull request overview
This PR adds a maintainer handoff/doc-ops bundle to make Stickler easier to operate without tribal knowledge (maintainer roster, CODEOWNERS, release runbook, changelog, and a maintainer-focused docs page).
Changes:
- Add maintainer/release artifacts:
MAINTAINERS.md,.github/CODEOWNERS,RELEASING.md,CHANGELOG.md. - Add a new “Maintainer’s Guide” MkDocs page and include it in the Contributing nav.
- Minor housekeeping: fix
AGENTS.mdreference, ignore.pytest_cache/, link maintainer resources fromCONTRIBUTING.md.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| RELEASING.md | Adds a step-by-step release runbook for publishing to PyPI/TestPyPI via GitHub Release + OIDC. |
| MAINTAINERS.md | Introduces a maintainer roster, responsibilities, and path to maintainership. |
| docs/docs/Getting-Started/Contributing/maintainers-guide.md | Adds maintainer-focused operational guidance (review bar, CI map, infra access, known landmines). |
| docs/docs/Getting-Started/Contributing/.nav.yml | Adds the new Maintainer’s Guide page to the Contributing section nav. |
| CONTRIBUTING.md | Links to maintainer roster, maintainer guide, and release process. |
| CHANGELOG.md | Adds Keep-a-Changelog formatted changelog with backfilled entries and compare links. |
| AGENTS.md | Removes a stale/nonexistent docs agent-file pointer. |
| .gitignore | Adds .pytest_cache/ to ignored files. |
| .github/CODEOWNERS | Adds default repo-wide code ownership for automatic maintainer review requests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Security Scan ResultsASH Security Scan Report
Scan Metadata
SummaryScanner ResultsThe table below shows findings by scanner, with status based on severity thresholds and dependencies:
Top 7 HotspotsFiles with the highest number of security findings:
Detailed FindingsShow 19 actionable findingsFinding 1: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 2: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 3: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 4: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 5: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 6: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 7: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 8: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 9: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 10: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 11: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 12: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 13: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 14: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 15: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 16: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 17: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 18: yaml.github-actions.security.github-actions-mutable-action-tag.github-actions-mutable-action-tag
Description: Code Snippet: Finding 19: package_managers.uv.uv-missing-dependency-cooldown.uv-missing-dependency-cooldown
Description: Code Snippet: Report generated by Automated Security Helper (ASH) at 2026-07-22T14:09:25+00:00 |
…x file path, clarify link text)
Issue Reference
no linked issue; maintainer-transition prep
Description of Changes
handoff pass to make project operations survivable without tribal knowledge: who maintains it, how releases ship, what changed per version, and what a new maintainer needs to know.
Changes Made
* @sromoamso every PR auto-requests a maintainer review[Unreleased]section for what's on devdocs/AGENTS.md;.pytest_cache/added to .gitignore; CONTRIBUTING links to the new maintainer docsTesting
mkdocs buildpasses and the new page renders in the nav