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 摘要。