Skip to content

Add wiki fast-forward rule to AGENTS.md #71

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
l1a merged 1 commit into from
Sep 1, 2026
Merged

Add wiki fast-forward rule to AGENTS.md #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,8 @@ and hard-fails on the first problem:

### 4.11 Wiki
Update the GitHub wiki **before opening the PR** (not deferred to publish time).
Clone `https://github.com/l1a/etr.wiki.git`, edit the relevant pages, and push:
Fast-forward an existing clone first (`git pull --ff-only`), or clone freshly
(`git clone https://github.com/l1a/etr.wiki.git`), edit the relevant pages, and push:
- [ ] **Home.md** — if the one-line project description or quick-start changed.
- [ ] **Getting-Started.md** — if prerequisites, install steps, or connection syntax changed.
- [ ] **How-It-Works.md** — if the connection lifecycle, reconnect logic, stream layout,
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "etr"
version = "0.8.2"
version = "0.8.3"
edition = "2024"
description = "A Rust implementation of Eternal Terminal (et)"
license = "GPL-3.0-only"
Expand Down
11 changes: 9 additions & 2 deletions NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,15 @@ the link drops. This project uses **QUIC** (via the `quinn` crate) for the tran
layer, which provides reliable, ordered, multiplexed streams with congestion control
and TLS 1.3 built-in.

## Current state: v0.8.2 — man page documentation for --reconnect-timeout
## Current State (v0.8.2)
## Current state: v0.8.3 — AGENTS.md §4.11 wiki clone fast-forward requirement
## Current State (v0.8.3)

Documentation & release hygiene (145 tests, unchanged).

- **`AGENTS.md` §4.11 updated with explicit wiki fast-forward instruction.**
Clarified that contributors/agents must fast-forward an existing local clone (`git pull --ff-only`) before making changes, preventing stale local clones from inadvertently reverting upstream wiki updates.

## Previous: v0.8.2 — man page documentation for --reconnect-timeout

Documentation fix (145 tests, unchanged).

Expand Down