Skip to content

docs: pre-v0.1.0 polish (README + CHANGELOG + SECURITY)#38

Merged
bilby91 merged 1 commit into
mainfrom
pre-v0-1-0-polish
May 11, 2026
Merged

docs: pre-v0.1.0 polish (README + CHANGELOG + SECURITY)#38
bilby91 merged 1 commit into
mainfrom
pre-v0-1-0-polish

Conversation

@bilby91
Copy link
Copy Markdown
Member

@bilby91 bilby91 commented May 11, 2026

Summary

Pre-tag polish that addresses three v0.1.0 milestone issues:

  • README — flip six spec-compliance rows that referenced now-closed issues to ✅:
    shutdownAction, initializeCommand, secretsCommand, ${containerEnv:*},
    nested unknown-field warnings, Alpine/BusyBox updateRemoteUserUID.
    Drop the stale test-count line and the link to the gitignored PRD.md.
  • CHANGELOG.md — Keep a Changelog format with a single `0.1.0` entry covering
    M1–M5 scope and known limitations.
  • SECURITY.md — private vulnerability reporting via GitHub Security
    Advisories, supported versions, response windows, hardening notes for
    embedders.

Closes #4, closes #5.

#3 (move `design/` to public `docs/`) is re-milestoned and retitled to
"write public-facing reference docs in docs/" for a follow-up release —
the current docs are decision logs, not user-facing reference material.

Test plan

  • README renders with no broken cross-references
  • CHANGELOG link references valid
  • No code changes; `go test ./...` unaffected

🤖 Generated with Claude Code

- README: flip 6 spec-compliance rows that referenced now-closed issues
  to ✅ (shutdownAction, initializeCommand, secretsCommand, ${containerEnv:*},
  nested unknown fields, Alpine updateRemoteUserUID); drop test-count and
  PRD link.
- CHANGELOG.md: Keep a Changelog format, single 0.1.0 entry summarizing
  M1–M5 scope plus known limitations.
- SECURITY.md: private-advisory reporting + supported versions +
  response windows + hardening notes for embedders.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

Warning

Rate limit exceeded

@bilby91 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 57 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c74382cc-dff3-47fe-a324-9893047ec171

📥 Commits

Reviewing files that changed from the base of the PR and between ab3c43c and 734050e.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • README.md
  • SECURITY.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pre-v0-1-0-polish

Comment @coderabbitai help to get the list of available commands and usage tips.

@bilby91 bilby91 merged commit 68fd3e5 into main May 11, 2026
4 of 5 checks passed
@bilby91 bilby91 deleted the pre-v0-1-0-polish branch May 11, 2026 03:49
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.

Add SECURITY.md Add CHANGELOG.md and start tracking from v0.1.0

1 participant