You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@magpie.apache.org by po...@apache.org on 2026/10/13 14:13:24 UTC

(magpie) branch main updated: docs(contributing):swap out link-check and swap in lychee (#1612)

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/magpie.git


The following commit(s) were added to refs/heads/main by this push:
     new 2343a412 docs(contributing):swap out link-check and swap in lychee (#1612)
2343a412 is described below

commit 2343a412f3ab6de3745a5b3d668be2604c82aef0
Author: Nic Crane <th...@gmail.com>
AuthorDate: Tue Oct 13 15:13:19 2026 +0100

    docs(contributing):swap out link-check and swap in lychee (#1612)
    
    Generated-by: Claude Code (Fable 5.1)
---
 CONTRIBUTING.md | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dde210ab..18aa1950 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -244,7 +244,7 @@ every piece of context it needs from some combination of the four
 ├── .pre-commit-config.yaml   # prek hook set (see "Running the dev loop")
 ├── pyproject.toml            # Workspace-level Python config
 ├── uv.lock                   # Reproducible Python lockfile
-└── .github/                  # CI: pre-commit, zizmor, link-check, ISSUE_TEMPLATE
+└── .github/                  # CI: pre-commit (incl. lychee), zizmor, ISSUE_TEMPLATE
 ```
 
 The adopter-side `.apache-magpie/` snapshot, the per-user
@@ -1046,9 +1046,10 @@ Good entry points, in rough order of ramp-up cost:
 2. **Documentation improvements.** Read a skill or a doc, find a
    gap or a stale reference, fix it. The `docs/setup/`,
    `docs/security/`, and `docs/pr-management/` trees are all
-   actively curated and welcome refinement. The `link-check`
-   workflow surfaces broken anchors and dead URLs daily — work
-   from that report is high-value.
+   actively curated and welcome refinement.
+   The `lychee` hook in the `pre-commit` workflow checks in-repo links and heading anchors on every pull request and push to `main`,
+   but it runs offline and never fetches external URLs.
+   Finding and fixing a dead external link by hand is therefore high-value work.
 
 3. **Eval fixtures.** [`tools/skill-evals/evals/`](tools/skill-evals/evals/)
    has 1000+ cases across all skills, but every skill could use more