docs: add a concrete patch announcement before/after example without generic AI copy

Chiusa Adatta ai principianti
  • Qualcosa non va?
#18 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #38 di @drevendev — integrata

Valutazione

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

Direzione di ricerca

Leggi guides/release-notes.md e CONTRIBUTING.md, quindi esamina l’esempio fittizio esistente di CLI 0.4.0 e i punti di partenza richiesti. Aggiungi una coppia esemplificativa di annunci, uno poco utile e uno utile, usando solo i fatti elencati, insieme ai tre titoli esplicativi richiesti; assicurati che i link di navigazione funzionino. Esegui il controllo dei link specificato, i test unitari e ogni controllo del catalogo applicabile, registrando not_run per i controlli che non vengono eseguiti.

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

Descrizione

good first issue hacktoberfest help wanted

Why

The existing release-note guide has one good release note before/after pair for a fictional CLI, but no short announcement comparison explaining how generic AI-style launch copy can be improved using exactly the same facts. Parent #17 asks for a broader editorial-quality kit; this is an independent first slice.

Scope (docs-only; newcomer-sized)

  • In guides/release-notes.md, after the existing fictional CLI 0.4.0 example, add one weak vs useful announcement pair based only on the same verified-as-fictional facts: option rename --csv-output → --output, malformed CSV emits exit code 1, PowerShell unverified. Label it illustrative, not a real product, release, or tested result.
  • Add a brief explanation of edits under the headings claim → evidence → reader impact and what a reader should do. Make the useful version specific and human, not pompous.
  • Preserve limitations; never invent download counts, users, benchmarks, quotes or test status.
  • Keep the existing guide/navigation links working. If the scope expands beyond one example, stop and link parent #17.

Acceptance

  • Same underlying facts in both versions; no hallucinated benefits or social proof.
  • A maintainer can point to three concrete wording differences and explain why readers benefit.
  • python tools/docs_links.py, python -m unittest discover -s tests -v and any applicable catalog check actually run; record not_run honestly.
  • English text; one focused PR; use CONTRIBUTING.md.

Starting points

guides/release-notes.md, guides/readme.md, CONTRIBUTING.md, and parent #17.

Effort: roughly 1–2 hours; please comment before starting.

Lingua principale
Python
Stelle
2
Fork
0
Merge medio
3h 40m
PR unite (30g)
174

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 drevendev/BeautifulRepo

Tutte le issue di drevendev/BeautifulRepo

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.