Skip to content

Add the missing community and governance files to Json #36

Open

Description

Context and request

Four of the community and governance files the Repository Standard requires are absent, along with the pull request template. README.md already links to CONTRIBUTING.md, so that link is currently broken.

Missing: CONTRIBUTING.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, .github/pull_request_template.md.

The organization .github fallback covers some of these in GitHub's web UI, but the standard is explicit that it is not sufficient: agents and humans need the files in the repository they are changing, and linters, review tooling, and local workflows do not read the fallback.

Acceptance criteria.

  • All five files exist at the paths the standard specifies.
  • SECURITY.md describes private vulnerability reporting and which versions are supported.
  • SUPPORT.md names where users ask for help.
  • CONTRIBUTING.md describes the contribution workflow for this repository and the README link resolves.
  • Opening a pull request scaffolds the MSX PR Format: icon plus change type plus user-facing outcome in the title, user-facing description sections, an optional technical-details block, and a related-issues block.
  • The repository linter passes on the new Markdown, including .github/linters/.markdown-lint.yml and the codespell configuration.

Technical decisions

Content is adopted from PSModule/Template-PSModule, which is the source of the default shape for module repositories. These files are organization policy statements and pointers, not repository-specific prose, so copying the template versions is correct — rewriting them would create drift the moment the template changes.

Only genuinely repository-specific details are adjusted: the module name, and any support channel that differs from the organization default.

All five ship in one pull request. They are a single governance baseline with no interdependency on the rest of the work, and splitting them produces five near-identical reviews.

None of these paths match ImportantFilePatterns, so the change is documentation-only and does not trigger a module build or release. Label accordingly.

Implementation plan

  • Fetch the current CONTRIBUTING.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, and .github/pull_request_template.md from Template-PSModule
  • Adjust module-specific references and confirm no template tokens remain
  • Confirm the CONTRIBUTING.md link in README.md resolves
  • Run the repository linter locally or confirm the pull request lint stage passes
  • Open a pull request and confirm the new template renders as expected in the description

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions