Skip to content

Add OSPO-standard sections to README - #14

Merged
nodeselector merged 1 commit into
mainfrom
nodeselector-readme-ospo-sections
Jul 8, 2026
Merged

Add OSPO-standard sections to README#14
nodeselector merged 1 commit into
mainfrom
nodeselector-readme-ospo-sections

Conversation

@nodeselector

@nodeselector nodeselector commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Adds the sections expected by the OSPO README template (github/open-source-releases) as part of open-sourcing this repo (OSPO release github/open-source-releases#710, epic github/actions-dispatch#570).

This is purely additive — all existing technical sections (Usage, Schema, Compatibility, Related projects, Development) are untouched.

What changed

Template sections already covered were left as-is: intro + status (title + Public preview note), Requirements (Installation), License. Acknowledgement was intentionally omitted.

All referenced files (CONTRIBUTING.md, SUPPORT.md, CODEOWNERS, LICENSE) were verified to exist in the repo.

Copilot AI review requested due to automatic review settings July 8, 2026 17:19
@nodeselector
nodeselector requested a review from a team as a code owner July 8, 2026 17:19
@nodeselector
nodeselector force-pushed the nodeselector-readme-ospo-sections branch from 7e09687 to 37f0004 Compare July 8, 2026 17:20

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Not ready to approve

The newly added roadmap link points to a non-public/non-resolvable GitHub issue, creating a broken reference for open-source readers.

Pull request overview

Adds OSPO README-template sections (Background, Support, Maintainers) to help position this repository for open-sourcing, while leaving existing technical documentation (Installation/Usage/Development/etc.) intact.

Changes:

  • Add a Background section describing project purpose, roadmap context, and contribution entry point.
  • Add a Support section linking to SUPPORT.md and setting expectations.
  • Add a Maintainers section pointing to the responsible maintainers and CODEOWNERS.
File summaries
File Description
README.md Adds OSPO-standard “Background”, “Support”, and “Maintainers” sections with links to repo governance files.

Review details

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Low

Note

Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
@nodeselector
nodeselector force-pushed the nodeselector-readme-ospo-sections branch from 37f0004 to fd37020 Compare July 8, 2026 17:24
@nodeselector
nodeselector merged commit 9be8c2a into main Jul 8, 2026
8 checks passed
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.

2 participants