Adopt the AI-native SDLC and repository policies

Đang mở
  • Có gì không ổn?
#634 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

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

Từ ngày 28/10/2026.

  • #635 của @goanpeca — đ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
20/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
developer-experience, devops, documentation

Hướng nghiên cứu

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.

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

Mô tả

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.
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.