B2 SDK docs: consolidate duplicated contributor guidance into one canonical source

Aperta
  • Qualcosa non va?
#599 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@ffumero2003 ci sta già lavorando.

Dal 9/9/2026.

  • #603 di @ffumero2003 — aperta

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
18/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
developer-experience, documentation

Direzione di ricerca

Start by comparing CONTRIBUTING.md with doc/source/contributing.rst and checking the session list against noxfile.py, which exposes the drift the issue describes. The work is already under way in pull request #603, so read that first and avoid duplicating it. Done means the maintainers have picked one canonical source, the second format is generated or included from it, or a parity check exists for the shared commands and supported versions.

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

Descrizione

Description

CONTRIBUTING.md and doc/source/contributing.rst independently duplicate environment setup, Nox sessions, Python support, testing, and documentation commands. They have already drifted: the Sphinx page contains a nonexistent deploy session, while the Markdown file contains dependency-management, lockfile, changelog-fragment, and filtered-test instructions missing from the Sphinx page. Because both appear authoritative, correcting one file does not reliably correct the contributor experience.

Steps to reproduce

1. Compare CONTRIBUTING.md with doc/source/contributing.rst section by section.
2. Check the session lists against noxfile.py.
3. Check whether dependency and changelog guidance appears in both documents.

Expected behavior

Choose and document one canonical source. Either include or generate the second representation from it, or add an automated parity check for deliberately duplicated facts such as commands and supported versions. Preserve a short GitHub-friendly entry point while keeping the full published contributor guide discoverable.

Actual behavior

Maintainers must update two formats manually, and there is no check that they remain equivalent. Readers already receive different command and release guidance depending on which copy they open, demonstrating that the duplication has become a correctness problem rather than only editorial overhead.

Environment

  • Python version: Not applicable
  • b2sdk version: master at f3ab7b71
  • OS: Not applicable
Lingua principale
Python
Stelle
214
Fork
68
Merge medio
51m
PR unite (30g)
6

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 Backblaze/b2-sdk-python

Tutte le issue di Backblaze/b2-sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.