Skip to content

Enhance Core Publish Readiness Registry and Update Documentation - #7

Merged
kcargile merged 15 commits into
developfrom
k/cr-001-agentsmd
Oct 20, 2026
Merged

kcargile merged 15 commits into
developfrom
k/cr-001-agentsmd

Conversation

@kcargile

Copy link
Copy Markdown
Contributor

This pull request finalizes the core agent guidance documentation for the OEI Core repository, aligning it with current project conventions and establishing a foundation for future publish readiness. The main updates include a complete rewrite of AGENTS.md, the introduction of a synthesized Copilot instructions file, and the creation of a detailed publish readiness registry. Documentation navigation and registry references have also been updated to reflect these additions.

Core Documentation and Guidance Updates:

  • Rewrote AGENTS.md to provide comprehensive, core-specific guidance on repository scope, package layout, documentation, tooling, branching, release process, and OSS posture. This replaces the previous placeholder and brings the guidance in line with OEI standards.
  • Added .github/copilot-instructions.md, synthesizing agent guidance from AGENTS.md for use by Copilot and other AI agents. This ensures consistent instructions for automated tooling and contributors.

Publish Readiness and Registry Improvements:

  • Created docs/registry/core-publish-readiness-registry.md, a detailed tracker for all workstreams required to bring OEI Core to publish-ready status, including audit status, evidence, and next steps for each item.
  • Updated documentation navigation: added the core publish readiness registry to docs/TOC.md and referenced it in docs/registry/README.md for improved discoverability. [1] [2]

Release Process and Changelog:

  • Added a changeset entry to document these updates and trigger a patch release for @openendurance/core.

@kcargile kcargile added this to the Initial Release milestone Oct 20, 2026
@kcargile kcargile self-assigned this Oct 20, 2026
Copilot AI balanced review requested due to automatic review settings October 20, 2026 11:58
@kcargile kcargile added the chore Chore not related to feature development. label Oct 20, 2026
@github-project-automation github-project-automation Bot moved this to Todo in OEI Core Oct 20, 2026
@changeset-bot

changeset-bot Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 25fced7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@openendurance/core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@kcargile kcargile moved this from Todo to In Progress in OEI Core Oct 20, 2026

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.

🟡 Changes recommended

The registry incorrectly identifies configured Biome artifact exclusions as a publish-readiness gap.

1 open issue
What changed in this PR

Establishes repository-specific agent guidance and a registry for tracking OEI Core’s publish readiness.

Changes:

  • Expands agent guidance and adds Copilot instructions.
  • Adds the publish-readiness registry and documentation links.
  • Adds a patch changeset for @openendurance/core.
File Description
docs/​TOC.md Links the new registry.
docs/​registry/​README.md Adds the registry to its index.
docs/​registry/​core-publish-readiness-registry.md Tracks readiness checks, evidence, and follow-up work.
AGENTS.md Replaces placeholder guidance with repository conventions.
.github/​copilot-instructions.md Adds aligned Copilot guidance.
.changeset/​smart-roses-sleep.md Records the documentation update for versioning.

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:02

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.

🟢 Approval recommended

No blocking findings remain in the documentation, navigation, and changeset updates.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:05

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.

🟡 Changes recommended

The registry’s table formatting must be corrected to satisfy the repository’s Markdown formatting check.

1 open issue

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:09

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.

🟡 Changes recommended

The root lint command removes Biome lint-rule validation from the CI path.

2 open issues

Review effort: Balanced

Comment thread package.json Resolved
Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:16

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.

🟡 Changes recommended

The CI test gate fails without test suites, and signing guidance needs corrections for setup, history-rewrite scope, and diagnostics.

4 open issues
2 resolved since last review

Review effort: Balanced

Comment thread .github/workflows/ci.yml Resolved
Comment thread docs/ops/commit-signing.md Resolved
Comment thread docs/ops/commit-signing.md Resolved
Comment thread docs/ops/commit-signing.md Resolved
Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:21

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.

🔵 Needs a closer look

The CI workflow skips its only validation job for Dependabot PRs.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Medium severity Dependabot PRs skip all required validation checks

.github/​workflows/​ci.yml:34

For PRs opened by dependabot[bot], this condition skips the workflow's only job, so none of the lint, build, typecheck, or test steps run. Skipped jobs can satisfy required status checks, leaving those dependency updates without validation from this workflow. Remove the actor guard so Dependabot PRs follow the same checks as other PRs.

4 resolved since last review

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:26
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
kcargile and others added 13 commits October 20, 2026 06:27
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
* Add CI workflow configuration for pull requests and pushes

Signed-off-by: Kristopher Cargile <k@algorythmic.com>

* Update concurrency group for CI workflow

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>

* Modify lint task fallback in CI workflow

Update lint task fallback to use dynamic SHA based on event.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>

---------

Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
… to readiness registry

Signed-off-by: Kristopher Cargile <k@algorythmic.com>
…R-001 as complete

Signed-off-by: Kristopher Cargile <k@algorythmic.com>
…tructions

Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Updated the status and evidence for various checks in the core publish readiness registry. Notable changes include the completion of AGENTS.md and adjustments to biome configuration and TypeScript settings.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Update commit signing instructions for rebase.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>
Update command to check commit signature in documentation.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kristopher Cargile <k@algorythmic.com>

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.

🟢 Approval recommended

No unresolved blocking issues remain, and the root-lint change was explicitly confirmed as intentional.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 12:30
Signed-off-by: Kristopher Cargile <k@openendurance.org>
@kcargile
kcargile merged commit 29cc2b9 into develop Oct 20, 2026
3 checks passed
@kcargile
kcargile deleted the k/cr-001-agentsmd branch October 20, 2026 12:31
@github-project-automation github-project-automation Bot moved this from In Progress to Done in OEI Core Oct 20, 2026

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.

🟢 Approval recommended

Static review identified no unresolved blockers, and the root-lint change is explicitly confirmed as intentional.

No open issues 🎉

Review effort: Balanced

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

Labels

chore Chore not related to feature development.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants