Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Check the README for dead links and fix the misleading Docker Hub badge

Aperta Adatta ai principianti
  • Qualcosa non va?
#220 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@knownshah ci sta già lavorando.

Dal 28/9/2026.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, github-actions, markdown, python
Ambito
documentation

Direzione di ricerca

Inizia da README.md e ispeziona i badge di Docker e del workflow, quindi esegui il comando Docker di lychee fornito su README.md, .github/CONTRIBUTING.md e .github/SECURITY.md. Correggi i link realmente non funzionanti e verifica il Docker Automated build badge; concludi controllando pyproject.toml, eseguendo uv lock e pre-commit e confermando che tutte le condizioni di completamento elencate siano soddisfatte.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

🔄 Updated for v5.0.0 (2026-10-08). Part of this is done: the broken docker.yml badge link is gone (the badges were reworked in the CI refactor, #223). The link check and the misleading "Docker Automated build" badge are still open, so the steps are trimmed to those. The version example is updated too.

🌱 This is a beginner-friendly issue. It's a documentation fix and a good first contribution: you'll learn how the README's badges work, and how to check a whole document for broken links with a tool rather than by eye. Ask questions in the comments at any point.

⚠️ Who can take this issue

  • Anyone. This change can be tested fully offline. If you have PESU credentials, run the live tests too; if you don't, say so in your PR and CI will run them after merge.
  • Wait until you're assigned. Comment to ask for the issue, then wait for a maintainer to assign it to you before writing any code. PRs for unassigned issues are closed without review.

The problem

The README's links and badges have changed a lot since the CI refactor (#223) and 5.0.0 (#241), and nothing checks them. The broken docker.yml badge link this issue first reported is gone: the badges now point to ci_checks.yml and deploy_prod.yml. Others may still be broken, and a link checker finds them all.

One badge is known to mislead: "Docker Automated build" (img.shields.io/docker/automated/pesudev/pesu-auth) reports Docker Hub's own "automated builds" feature. pesu-auth's images are built by GitHub Actions instead: deploy_prod.yml builds the image, pushes it to GHCR, and its release job copies it to Docker Hub. Look at what the badge renders, and remove it or replace it (for example with a pull-count badge) if it's wrong. Check the neighbouring "build commit" badge too, and make sure it shows what its label says.

Step-by-step guide

Step 1: Check every link

Run a link checker over the Markdown files, for example lychee with Docker, so you don't need to install anything:

docker run --rm -v "$PWD":/input lycheeverse/lychee --no-progress /input/README.md /input/.github/CONTRIBUTING.md /input/.github/SECURITY.md

Fix every real broken link it reports. Some sites block automated checkers (they return 403 or 429); open those in a browser before deciding. List what you found and fixed in your PR.

Step 2: Check the badges

Open the README on your fork's GitHub page, and check that every badge renders and every badge link goes where it should.

Step 3: Open your PR
  • Bump the minor version in pyproject.toml (for example 5.0.0 → 5.1.0), then run uv lock. CI checks this. If someone else's PR merges first, bump again from the new version.
  • Run uv run pre-commit run --all-files and fix anything it reports.
  • Open the PR from your fork, against the dev branch.
  • Use a Conventional Commit title, e.g. docs: fix broken README links.
  • Write Closes #220 in the PR description.

Done when

  • A link checker reports no real broken links in README, CONTRIBUTING and SECURITY; the PR lists what was found
  • The "Docker Automated build" badge is either accurate or removed
  • Pre-commit passes, the version is bumped, and the PR is from your fork against dev
Lingua principale
Python
Stelle
23
Fork
30
Merge medio
1g 2h
PR unite (30g)
23

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pesu-dev/auth

Tutte le issue di pesu-dev/auth

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.