diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c29af5e..1e2f35f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,17 @@ change from your editor into `main`. > [launchbound](https://github.com/vyncint/launchbound), > [reconverge](https://github.com/vyncint/reconverge). Learn it once. +## Where to start + +- New here? The [`good first issue`](https://github.com/vyncint/termlens/labels/good%20first%20issue) + label collects work sized for a first patch: one file, no architecture + decisions. +- Open a draft PR early — it is the cheapest way to confirm direction before + you write much. +- Two things trip people up here: commits need `git commit -s` for the + [DCO](#5-developer-certificate-of-origin-dco), and snapshot updates are + reviewed with `cargo insta review`, never blind-accepted. + ## 1. Dev setup ```sh diff --git a/README.md b/README.md index 1c52643..91d8676 100644 --- a/README.md +++ b/README.md @@ -347,7 +347,9 @@ Other agents take the same file — a Cursor rule, or a reference from ## Contributing Pull requests are welcome — [CONTRIBUTING.md](https://github.com/vyncint/termlens/blob/main/CONTRIBUTING.md) has the dev -setup, the testing policy and the DCO sign-off. Three things to know before +setup, the testing policy and the DCO sign-off, and +[Where to start](https://github.com/vyncint/termlens/blob/main/CONTRIBUTING.md#where-to-start) +points at the `good first issue` label. Three things to know before starting: every change lands with tests; anything touching wait semantics must pass the 100-iteration [stress workflow](https://github.com/vyncint/termlens/blob/main/.github/workflows/stress.yml) on Linux, macOS and Windows; snapshot updates are reviewed diffs