mllam/neural-lam

Add markdown link check + PR template doc-update reminder to keep CONTRIBUTING/AGENTS from rotting

Open

#654 opened on Jun 8, 2026

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (276 forks)auto 404
cicdgood first issuemaintenance

Repository metrics

Stars
 (282 stars)
PR merge metrics
 (PR metrics pending)

Description

Once #407 lands the CONTRIBUTING.md + trimmed AGENTS.md, the documents will only stay accurate if drift is caught early. Two lightweight mechanisms would do most of the work:

Markdown link checker in pre-commit

Add the markdown-link-check (or lychee) hook to .pre-commit-config.yaml so every PR validates:

  • Cross-file references (CONTRIBUTING.md -> LICENSE.txt, AGENTS.md -> CONTRIBUTING.md#before-you-push).
  • Section anchors (catches when a section is renamed and a link to it stops resolving).
  • External URLs (catches when the Slack invite, Zoom redirector, or upstream-tool links rot).

PR template reminder

Add one checklist item to .github/pull_request_template.md:

- [ ] If this PR changes contributor workflow, I've updated CONTRIBUTING.md / AGENTS.md

Refs #407.

Contributor guide

Research direction
Set up the pre commit config with markdown link check or lychee hook, and add a checklist item to the PR template reminding contributors to update CONTRIBUTING.md and AGENTS.md when workflow changes.
Tech stack
python
Domain
documentationci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85