Skip to content

chore: clarify review cycle and update collaboration guide#10889

Merged
jasonsaayman merged 2 commits into
v1.xfrom
docs/clarify-review-cycle-in-collab
May 13, 2026
Merged

chore: clarify review cycle and update collaboration guide#10889
jasonsaayman merged 2 commits into
v1.xfrom
docs/clarify-review-cycle-in-collab

Conversation

@jasonsaayman

@jasonsaayman jasonsaayman commented May 13, 2026

Copy link
Copy Markdown
Member

Summary by cubic

Clarifies the collaborator review cycle and strengthens guidance on triage, PR expectations, and security practices in COLLABORATOR_GUIDE.md. Adds a 21‑day window for PR change requests and aligns the guide with AGENTS.md, THREATMODEL.md, and SECURITY.md.

Description

A clear and concise description of the PR.

Use this section for review hints, explanations or discussion points.

  • Summary of changes
    • Rewrote and restructured the collaborator guide with clear sections (Code of Conduct, Triage, Questions, Submit PRs, Security, Do/Don’t).
    • Set policy to not close issues for inactivity; request minimal reproductions and convert off‑topic issues to discussions.
    • Added a detailed PR checklist (scope, adapter parity, types index.d.ts/index.d.cts, AxiosError handling, tests/CI, deps, security‑sensitive areas, deprecations, API shape, Conventional Commits, semver targeting).
    • Introduced a 21‑day response window for requested PR changes before closing (reopen if addressed).
    • Documented security disclosure process via SECURITY.md and a short “do not do” list (ignore-scripts, runtime deps, weakening safeguards).
  • Reasoning
    • Make expectations explicit, reduce regressions, and standardize reviews across maintainers.
    • Improve responsiveness without losing history; ensure security‑related changes get extra scrutiny.
  • Additional context
    • Targets v1.x guidance; no runtime or API changes.

Docs

Please mirror the updated guidance on the docs site in /docs/:

  • Add or update a “Collaborator Guide” page, and cross‑link from “Contributing”.
  • Link to AGENTS.md, THREATMODEL.md, SECURITY.md, and the Code of Conduct.
  • Update sidebar/navigation to surface the review cycle and PR checklist.

Testing

No tests added. This is a documentation‑only change; no test coverage required.

Semantic version impact

No version impact. Documentation update only; no release change needed.

Written for commit 7a0dc7c. Summary will update on new commits.

@jasonsaayman jasonsaayman self-assigned this May 13, 2026
@jasonsaayman jasonsaayman added priority::medium A medium priority commit::chore The PR is related to a chore labels May 13, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

@jasonsaayman jasonsaayman merged commit 26a8729 into v1.x May 13, 2026
25 checks passed
@jasonsaayman jasonsaayman deleted the docs/clarify-review-cycle-in-collab branch May 13, 2026 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::chore The PR is related to a chore priority::medium A medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant