mllam/neural-lam

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

Open

#654 aperta il 8 giu 2026

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Python (276 fork)auto 404
cicdgood first issuemaintenance

Metriche repository

Star
 (282 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Configura il pre commit con un hook per markdown link check o lychee e aggiungi una voce di checklist al template PR per ricordare ai contributori di aggiornare CONTRIBUTING.md e AGENTS.md quando il flusso di lavoro cambia.
Tech stack
python
Dominio
documentationci cd
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85