From 93dc99c3cba481a9263d87ff59eef0259826d1d4 Mon Sep 17 00:00:00 2001 From: Devansh Gangwar Date: Sun, 13 Sep 2026 11:36:53 +0530 Subject: [PATCH 1/3] docs : add contibutor getting started guide Signed-off-by: Devansh Gangwar --- CONTRIBUTING.md | 6 ++++++ README.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c29af5e..ba911db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,12 @@ Thanks for your interest! This document covers everything you need to get a change from your editor into `main`. +## Where to start + +- New to the project? Start with the [good first issue](https://github.com/vyncint/temlens/labels/good%20first%20issue)label. +- Draft PRs are welcome early - opening one can help confirm direction before you do too much work. +- Two things that commonly trip contributors up: use `git commit -s` for the DCO , and review snapshot changes with `cargo insta review` rather than blindly accepting them. + > **These four projects share one contributor pattern** — the same commit > rules, the same DCO, the same AI policy, the same CI and release shape: > [termlens](https://github.com/vyncint/termlens), diff --git a/README.md b/README.md index 1c52643..c5ad872 100644 --- a/README.md +++ b/README.md @@ -347,7 +347,7 @@ 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.**Start with the [Where to start](CONTRIBUTING.md#where-to-start)section.** 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 From 7a7d3a25a5eccdd6c61fe720dda4c964e91bad3f Mon Sep 17 00:00:00 2001 From: Devansh Gangwar Date: Sun, 13 Sep 2026 14:16:45 +0530 Subject: [PATCH 2/3] docs : fix contributor guide link Signed-off-by: Devansh Gangwar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c5ad872..14d989e 100644 --- a/README.md +++ b/README.md @@ -347,7 +347,7 @@ 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.**Start with the [Where to start](CONTRIBUTING.md#where-to-start)section.** Three things to know before +setup, the testing policy and the DCO sign-off.**Start with the [Where to start](https://github.com/vyncint/termlens/blob/main/CONTRIBUTING.md#where-to-start)section.** 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 From 0f92ab86ba9d95c6e70e0ac21d3fd3ed0ca336fc Mon Sep 17 00:00:00 2001 From: Vyncint Ng <115854244+vyncint@users.noreply.github.com> Date: Sun, 13 Sep 2026 16:28:02 +0700 Subject: [PATCH 3/3] docs: fix the good first issue link and tighten the new section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The label link pointed at `github.com/vyncint/temlens` (missing the `r`), which is a 404 — and #314's "Done when" asks specifically that the label link resolve, so the section did not yet do the one job it exists for. Alongside that: - Restore the missing spaces around the README link and the `)label` run-on, and drop the stray space before the comma. - Move the section below the four-projects callout so the framing note still sits directly under the intro, and use the house em-dash. - Point the DCO mention at §5 rather than restating it, and keep the section unnumbered so §1–§8 keep their numbers: the PR template links §5 and §6. - In the README, append the pointer to the sentence instead of splitting it mid-clause, since the "Three things to know" list follows immediately. Verified: both URLs return 200, `#5-developer-certificate-of-origin-dco` and `#where-to-start` match real headings, and check-readme-links.sh passes. Signed-off-by: Vyncint Ng <115854244+vyncint@users.noreply.github.com> --- CONTRIBUTING.md | 17 +++++++++++------ README.md | 4 +++- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba911db..1e2f35f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,6 @@ Thanks for your interest! This document covers everything you need to get a change from your editor into `main`. -## Where to start - -- New to the project? Start with the [good first issue](https://github.com/vyncint/temlens/labels/good%20first%20issue)label. -- Draft PRs are welcome early - opening one can help confirm direction before you do too much work. -- Two things that commonly trip contributors up: use `git commit -s` for the DCO , and review snapshot changes with `cargo insta review` rather than blindly accepting them. - > **These four projects share one contributor pattern** — the same commit > rules, the same DCO, the same AI policy, the same CI and release shape: > [termlens](https://github.com/vyncint/termlens), @@ -16,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 14d989e..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.**Start with the [Where to start](https://github.com/vyncint/termlens/blob/main/CONTRIBUTING.md#where-to-start)section.** 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