Skip to content

docs(readme): add status/scope and contribution path for benchmark targets#34

Merged
aryeko merged 1 commit intomainfrom
chore/readme-status-scope
Feb 7, 2026
Merged

docs(readme): add status/scope and contribution path for benchmark targets#34
aryeko merged 1 commit intomainfrom
chore/readme-status-scope

Conversation

@aryeko
Copy link
Contributor

@aryeko aryeko commented Feb 7, 2026

Type

  • feat - New capability
  • fix - Bug fix
  • docs - Documentation only
  • test - Test changes
  • chore - Tooling, CI, maintenance

Summary

Adds two contributor-facing sections to README: a clear status/scope statement and a concrete path for contributing new benchmark targets. This improves onboarding and makes repository intent explicit for new users.

Changes

  • Add Status & scope section with current targets and publication scope
  • Add How to contribute benchmark targets section with command-level workflow

Validation

go test ./...

Checklist

  • Code and docs follow project conventions
  • Tests updated/added for behavior changes
  • Parity contract/fixtures updated if API behavior changed
  • Related design/docs updated if matcher semantics changed

Resolves

Resolves #

@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2026

Warning

Rate limit exceeded

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

⌛ 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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/readme-status-scope

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

@codecov
Copy link

codecov bot commented Feb 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@aryeko aryeko merged commit 8ff05bd into main Feb 7, 2026
8 checks passed
@aryeko aryeko deleted the chore/readme-status-scope branch February 7, 2026 21:01
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.

1 participant