Skip to content

📖 [Docs]: Repository Standard reads as the enterprise-wide default with an accurate required-files baseline#117

Draft
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
mainfrom
docs-116-repository-standard-alignment
Draft

📖 [Docs]: Repository Standard reads as the enterprise-wide default with an accurate required-files baseline#117
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
mainfrom
docs-116-repository-standard-alignment

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

The Repository Standard now reads as the enterprise-wide default that every MSX repository inherits, and it makes clear that initiative standards such as PSModule sit at the same altitude — adding to and adjusting the baseline rather than living beneath it. The required-files baseline now matches what repositories actually need: agent-onboarding files are listed, files that are only relevant to some repositories are no longer mandatory, and the vaguer file descriptions now explain what each file is actually for.

Changed: The standard states its own scope and altitude

A reader can now tell, from the intro, that the Repository Standard is the default for every repository across the MSX Enterprise regardless of initiative, organization, or technology. The intro and the Initiative implementation guidance section both make the layering explicit: initiative standards operate at the same altitude as this standard, not beneath it. A repository inherits every rule this standard sets unless its initiative explicitly changes it, and where an initiative standard adds or overrides a rule, the initiative standard governs that initiative's repositories.

Changed: The required-files baseline matches what repositories actually need

The required-files table now lists the agent-onboarding entry points AGENTS.md and CLAUDE.md. It no longer treats .github/release.yml or .github/linters/* as mandatory baseline files, because those apply only when a repository generates releases or runs those linters. The descriptions for .github/pull_request_template.md, .gitattributes, .gitignore, and .github/dependabot.yml now describe what each file does — PR Format alignment, cross-platform line handling, ecosystem-tailored ignores, and ecosystem-appropriate dependency updates. The Linter configuration defaults section stays as guidance, but no longer frames repository-local linter config as a mandatory baseline file.


Technical details
  • Single-file change to src/docs/Ways-of-Working/Repository-Standard.md; frontmatter, heading structure, and writing style preserved.
  • Added a same-altitude layering paragraph to the intro and reinforced it in the Initiative implementation guidance section.
  • Required files table: added AGENTS.md and CLAUDE.md rows; removed the .github/release.yml and .github/linters/* rows; reworded .github/pull_request_template.md (now links to PR-Format.md), .gitattributes, .gitignore, and .github/dependabot.yml. Did not add .github/copilot-instructions.md.
  • Softened the Linter configuration defaults section from mandatory framing to applies-when-used guidance.
  • Implementation plan progress: all plan steps in Align Repository Standard scope, layering, and required-files baseline #116 completed in this PR; no follow-up delivery issues.
Changed surface Standards checked Framework docs checked Result
src/docs/Ways-of-Working/Repository-Standard.md Repository Standard, PR Format, Issue Format Ways of Working Aligned
Relevant issues (or links)

…ring in Repository Standard intro

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
These apply only when a repository generates releases or runs those linters, so they are not part of the enterprise-wide baseline.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…e descriptions to be ecosystem-aware and PR Format aligned

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ntation guidance section

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…her than a mandatory baseline file

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Align Repository Standard scope, layering, and required-files baseline

1 participant