Skip to content

AGENTS.md references a CONTRIBUTING.md that doesn't exist in this repo #81

Description

Problem

This repo's root AGENTS.md tells readers to check [CONTRIBUTING](CONTRIBUTING.md) for "how to contribute and the review process," but no CONTRIBUTING.md file exists anywhere in PSModule/docs.

Context / complication

There is an org-level CONTRIBUTING.md in PSModule/.github/.github/CONTRIBUTING.md, which GitHub surfaces as a community-health-file fallback for any PSModule repo that lacks its own. So the link isn't purely broken in the GitHub UI — but it contradicts this repo's own documented standard.

Modules/Repository-Defaults.md (in this repo) states repositories should carry their own community files "instead of relying on the organization .github fallback," and explicitly says PSModule/docs follows that same baseline itself. MSXOrg/docs's Ways-of-Working/Repository-Standard.md similarly lists CONTRIBUTING.md as a required per-repo file, not an org-fallback item.

So there's a real inconsistency: this repo's own docs say every repo (including this one) should have its own CONTRIBUTING.md, but this repo doesn't have one and instead silently relies on the org fallback it warns against.

Options to resolve

  1. Add a minimal CONTRIBUTING.md to PSModule/docs (e.g. pointing to MSXOrg/docs's Contribution Workflow for the general process, plus any docs-repo-specific notes such as building/previewing with Zensical).
  2. Or adjust AGENTS.md to stop pointing at a file that doesn't exist, and instead state explicitly that this repo relies on the org-level community-health fallback (if that's an accepted, intentional exception to Repository-Defaults.md).

Either way, Modules/Repository-Defaults.md's claim that PSModule/docs "follows those two baseline expectations itself" should be reconciled with whichever option is chosen — right now it's not accurate as written given the file is missing.

Found via

Discovered while researching PSModule/docs routing for a Template-PSModule AGENTS.md slimming effort.

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