Skip to content

Document which files inherit and which don't in README #65

@JacobPEvans

Description

@JacobPEvans

Problem

The .github README doesn't clearly document what inherits automatically vs what requires manual action.

Key Findings from ai-workflows Audit

Auto-inherited (when present at root):

  • CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, SUPPORT.md, FUNDING.yml
  • Issue templates (.github/ISSUE_TEMPLATE/)
  • PR templates (.github/PULL_REQUEST_TEMPLATE/)

NOT inherited (must be copied or synced):

  • GitHub Actions workflows (.github/workflows/)
  • Labels (requires gh label clone or label-sync automation)
  • Branch protection rules
  • Repository settings

Suggested Fix

Add an "Inheritance" section to the README explaining what propagates automatically and what needs manual action.

Found during ai-workflows inheritance audit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:mediumMedium - Normal workflow (semver: standard)size:sS - Simple change, 1-4 hourstype:docsDocs - Documentation only changes

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions