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

Offen
  • Stimmt etwas nicht?
#599 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@ffumero2003 arbeitet bereits daran.

Seit 09.9.2026.

  • #603 von @ffumero2003 — offen

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
18/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
developer-experience, documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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
Vorherrschende Sprache
Python
Sterne
214
Forks
68
Ø Merge
51 Min.
Gemergte PRs (30 T.)
6

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Backblaze/b2-sdk-python

Alle Issues in Backblaze/b2-sdk-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.