From be711a886a3069e078aaa100769d09bac4be44bc Mon Sep 17 00:00:00 2001 From: Bamdad Dashtban Date: Tue, 14 Jul 2026 10:54:57 +0100 Subject: [PATCH] docs: point newcomers to the good first issues Add a Contributing section to the README linking the good-first-issue label, and make the CONTRIBUTING 'Good first issues' section a live link to the label (and help-wanted), noting that each issue carries file:line pointers and acceptance criteria. --- CONTRIBUTING.md | 7 +++++-- README.md | 6 ++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d8a195..bb118cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,8 +17,11 @@ uv run pre-commit install reported mean ± std over 3+ seeds. ## Good first issues -See the `good first issue` label. If the tracker is empty, open an issue -describing what you'd like to add and we'll scope it together. +See the [`good first issue`](https://github.com/bamdadd/steerbench/labels/good%20first%20issue) +label (most are also tagged [`help wanted`](https://github.com/bamdadd/steerbench/labels/help%20wanted)). +Each one has a problem description, file:line pointers, and acceptance criteria +including which test to add. If the tracker is empty, open an issue describing +what you'd like to add and we'll scope it together. ## Reproducibility rules - Pin versions (the `uv.lock` is committed). diff --git a/README.md b/README.md index 0e3d019..b8cc468 100644 --- a/README.md +++ b/README.md @@ -159,6 +159,12 @@ sentiment, verbosity). non-determinism bug found while building steerbench, and the one-line fix ([vgel/repeng#79](https://github.com/vgel/repeng/pull/79)). +## Contributing + +Contributions welcome — start with the [good first issues](https://github.com/bamdadd/steerbench/labels/good%20first%20issue) +(each has file:line pointers and acceptance criteria). See +[CONTRIBUTING.md](CONTRIBUTING.md) for setup and the checks a PR must pass. + ## License MIT.