Skip to content

docs : add contibutor getting started guide #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vyncint merged 3 commits into from
Sep 13, 2026
Merged

docs : add contibutor getting started guide #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93dc99c
docs : add contibutor getting started guide
Sep 13, 2026
7a7d3a2
docs : fix contributor guide link
Sep 13, 2026
0f92ab8
docs: fix the good first issue link and tighten the new section
vyncint Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down