Improve developer documentation

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

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
55/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
停滯
技術堆疊
python
領域
documentation

研究方向

Start with CONTRIBUTING.md at the repository root and follow the four requested changes: put the Python installation section first, link to the CI build configuration, add a short overview of repo structure and test strategy, and note when a CHANGELOG entry is needed. The payload does not name the CI config file or the test layout, so find those yourself. Done means the document reads in order for a new contributor, and someone has followed it on a clean machine, including the Python version issue on macOS 11 that the issue reports.

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

描述

This could be as simple as updating the CONTRIBUTING.md to be more accessible:

  • start with recommended system installation of python(s) first before other sections
  • link to the configuration of the commands run on CI build + expectations on what is done locally vs. at pr-time
  • high-level overview of repo structure and test strategy (old strategy vs. new, where to add tests and when)
  • the need for a CHANGELOG message

Also I'd recommend trying a fresh setup by literally following the instructions, it's quite sparse, and as I said, I cannot get python <= 3.6 functioning on my machine, so others running a similar later version of macOS 11 are likely to experience the same issue.

主要語言
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 摘要。