Skip to content

📚 [platform] Establish organization-wide default community health files #24

Description

@szmyty

Outcome

Complete the egohygiene/.github repository as the organization-wide source of default GitHub community health files, following GitHub's supported fallback model while allowing repositories to override defaults when they need repository-specific policy.

Context

The .github repository was created specifically to centralize organization defaults. The current setup journey established the funding configuration and identified the broader community-health surface that still needs to be designed deliberately rather than added ad hoc.

GitHub-supported defaults to evaluate include:

  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • GOVERNANCE.md
  • SECURITY.md
  • SUPPORT.md
  • issue templates and config.yml
  • pull request templates
  • discussion category forms where useful
  • FUNDING.yml (already bootstrapped; preserve and validate rather than recreate)

A default license is explicitly out of scope because licenses belong in individual repositories.

Scope

  • Inventory the current egohygiene/.github repository before editing.
  • Define which supported community health files should be universal defaults versus intentionally repository-specific.
  • Add concise, organization-appropriate defaults for the universal set.
  • Keep repository-local overrides authoritative.
  • Document GitHub's precedence/fallback behavior so contributors understand why a repository may not use the organization default.
  • Ensure issue-template behavior accounts for GitHub's rule that a repository-local .github/ISSUE_TEMPLATE prevents use of the default issue-template directory.
  • Coordinate issue-template and label work with the canonical organization intake/taxonomy issue rather than duplicating that design.
  • Validate Markdown links and GitHub-recognized paths.

Acceptance criteria

  • The supported GitHub community-health file types have an explicit adopt/defer/repository-specific decision.
  • Adopted organization defaults exist at GitHub-recognized paths.
  • FUNDING.yml remains valid and organization-wide behavior is documented.
  • No default license is introduced.
  • Repository-local override semantics are documented.
  • Issue-template behavior is coordinated with organization issue intake and label taxonomy.
  • Security and support guidance does not promise channels or response guarantees that have not been established.
  • All local Markdown links resolve.

Dependencies / related work

Reference

  • GitHub Docs: Creating a default community health file

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions