Adopt the AI-native SDLC and repository policies

未关闭
  • 哪里不对？
#634 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@goanpeca 已经在做这个了。

开始于 2026年10月28日。

  • #635 来自 @goanpeca —— 未关闭

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
developer-experience, devops, documentation

调研方向

Review the proposed files and workflow in the issue, especially intent/review-process/intent.md, README.release.md, and the existing nox sessions and towncrier checks. The issue spans repository policy, contributor guidance, release documentation, CI decisions, and a maintainer review proposal; first read the linked pull request and confirm with maintainers which parts remain in scope. Done means the agreed policies and workflows are documented and any admin decisions are recorded.

由索引模型根据 Issue 内容生成。

描述

enhancement

Problem

More and more b2-sdk-python PRs are written with coding agents, and nothing in the repo tells an agent (or a new contributor) how this codebase works or what reviewers keep asking for. The rules live in reviewers' heads and in past review threads: towncrier fragments in changelog.d/ with the right name and type, changes made in b2sdk/_internal and exported through the right b2sdk/vN apiver layer without breaking older layers, raw_simulator.py kept in step with raw_api.py, tests that fail when the fix is reverted, retry and Retry-After parity, and the .sdkharness contract checks that CI does not run. The release steps are a single line in README.release.md.

The repo also lacks the standard policy files: no AGENTS.md/CLAUDE.md, REVIEW.md, SECURITY.md, CODE_OF_CONDUCT.md, PR template or issue forms.

Proposed outcome

  • Agents and contributors read the recurring review lessons before they write code (AGENTS.md, CLAUDE.md, docs/review-lessons.md), and reviewers follow one written process (REVIEW.md).
  • Keep towncrier and the existing CI changelog check; document them where agents look, and make the local check easy to run.
  • A documented release process (RELEASE.md, replacing README.release.md), security policy, code of conduct, PR template and issue forms.
  • One documented local command sequence that mirrors CI (nox -s lint, unit, build, doc, towncrier_check).
  • Larger changes start from intent/<slug>/intent.md → spec.md → plan.md, following the AI-native SDLC playbook, with the playbook skills in .claude/skills/.
  • A proposal, for the maintainers to decide, on scaling human review by risk (tiers, re-approval on new commits, required conversation resolution, automated AI and security review, merge queue, reviewer evals, metrics).

Settings that need a repo admin

  • Enable private vulnerability reporting (needed by SECURITY.md and the issue form's security link).
  • Decide whether the changelog validation step should become a required check on master.
  • Confirm which branch protection is applied to master.
  • Review intent/review-process/intent.md and accept, reshape or close it.
主要语言
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 摘要。