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

Đang mở
  • Có gì không ổn?
#599 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@ffumero2003 đang làm issue này rồi.

Từ ngày 9/9/2026.

  • #603 của @ffumero2003 — đang mở

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
18/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
developer-experience, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Python
Star
214
Fork
68
Merge trung bình
51 phút
Pull request đã merge (30 ngày)
6

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Backblaze/b2-sdk-python

Tất cả issue của Backblaze/b2-sdk-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.