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

Abierto
  • ¿Algo no está bien?
#599 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@ffumero2003 ya está trabajando en esto.

Desde el 9/9/2026.

  • #603 de @ffumero2003 — abierto

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
18/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
developer-experience, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
214
Forks
68
Merge medio
51 min
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Backblaze/b2-sdk-python

Todos los issues de Backblaze/b2-sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.