Skip to content

Add governance docs and v1 prep updates (README + release review)#7

Merged
squeakycheese75 merged 3 commits into
mainfrom
codex/review-code-for-public-release-v1
Apr 7, 2026
Merged

Add governance docs and v1 prep updates (README + release review)#7
squeakycheese75 merged 3 commits into
mainfrom
codex/review-code-for-public-release-v1

Conversation

@squeakycheese75

Copy link
Copy Markdown
Contributor

Motivation

  • Prepare the repository for an upcoming v1 by formalizing contributor and governance processes and publishing security/contact guidance.
  • Make the public stability message explicit so users understand v1 expectations and reduce accidental API commitments.
  • Surface the current release readiness state and outstanding v1 blockers so maintainers have a clear checklist to finish the release.

Description

  • Add CONTRIBUTING.md with the development workflow, PR expectations, and a public API policy note.
  • Add CODE_OF_CONDUCT.md to define expected behavior and enforcement contacts.
  • Add SECURITY.md to document vulnerability reporting and supported-version guidance.
  • Update README.md status badge and stability blurb to reflect "v1-prep" and new messaging.
  • Expand RELEASE_READINESS_REVIEW.md into a v1-focused review that lists improvements, v1 blockers, should-fix items, and a go/no-go checklist.

Testing

  • Ran go test ./... across the repository and the test suite completed successfully.

Codex Task

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 31687b63c1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread RELEASE_READINESS_REVIEW.md Outdated
## v1 blockers (must fix before tagging `v1.0.0`)

1. **Public stability message conflicts with v1 expectations**
- README still labels the project as `alpha` and explicitly says APIs may change.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove stale alpha blocker from v1 review

This blocker is now factually incorrect: the same commit updates README.md to status-v1--prep and replaces the early-development warning, so saying the README "still labels the project as alpha" is stale. Leaving this in the v1 blocker list can mislead release decisions and keep a completed task marked as unresolved.

Useful? React with 👍 / 👎.

@squeakycheese75 squeakycheese75 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

lgtm

@squeakycheese75
squeakycheese75 merged commit 6dc9018 into main Apr 7, 2026
3 checks passed
@squeakycheese75
squeakycheese75 deleted the codex/review-code-for-public-release-v1 branch April 7, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant