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

未關閉
#599 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

@ffumero2003 已經在處理了。

開始於 2026年9月9日。

  • #603 來自 @ffumero2003 —— 未關閉

評估

難度
5/5
預估耗時
一週以上
新手友好度
18/100
Issue 類型
文件
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
python

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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

主要語言
Python
星號
214
分支
68
平均合併
51 分鐘
30 天內合併 PR
6

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Backblaze/b2-sdk-python 的其他 Issue

查看 Backblaze/b2-sdk-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。