Skip to content

docs: add development workflow playbook (fix/feature/release)#81

Merged
rolling-codes merged 1 commit into
mainfrom
docs/development-workflow
Jul 11, 2026
Merged

docs: add development workflow playbook (fix/feature/release)#81
rolling-codes merged 1 commit into
mainfrom
docs/development-workflow

Conversation

@rolling-codes

@rolling-codes rolling-codes commented Jul 11, 2026

Copy link
Copy Markdown
Owner

What changed

Adds docs/development-workflow.md — the end-to-end "how we ship" guide for maintainers and contributors, covering the three workflows the repo's machinery already implies:

  • Refine/fix: the verify-first loop (failing test before fix, atomic conventional commits, bugs.md logging)
  • Add a feature: decision tree across the three surfaces (bundled plugin / core capability / external plugin), with the reputation.py anatomy, ServerConfigStore.mutate RMW rule, and test/docs/changelog requirements
  • Release: bump_version.py → notes.md + CHANGELOG → Release Drafter label table → publish triggers PyPI upload

Also links the new guide from CONTRIBUTING.md (one-line pointer) and both tables in docs/README.md.

Why

CONTRIBUTING.md covers standards and conventions but no doc tied together the full lifecycle from branch to PyPI; the release steps and label→version mapping lived only in workflow YAML and scripts.

Test plan

  • python scripts/check_release_metadata.py passes (no version drift introduced)
  • All relative links in the new doc resolve (organizing-code.md, plugin-authoring.md, testing.md, CONTRIBUTING.md anchor)
  • Docs-only change — no code paths touched; full suite unaffected

Summary by Sourcery

Add a maintainer-focused development workflow playbook describing how to refine/fix behavior, add features, and perform releases, and link it from contributor and docs indexes.

Documentation:

  • Introduce docs/development-workflow.md as an end-to-end guide for fix/feature/release workflows, local gates, and release process.
  • Link the new Development Workflow guide from CONTRIBUTING.md and the docs index tables to surface contributor workflows.

@rolling-codes rolling-codes added the documentation Improvements or additions to documentation label Jul 11, 2026
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@sourcery-ai

sourcery-ai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds a new documentation playbook describing the end-to-end development workflow for fixes, features, and releases, and wires it into existing contributor and docs indexes so maintainers and contributors have a single “how we ship” reference without changing any code paths.

Flow diagram for the label-driven release workflow

flowchart TD
    Developer([Developer])
    bump_version_py[bump_version.py]
    check_release_metadata_py[check_release_metadata.py]
    ReleaseDrafter[ReleaseDrafter]
    GitHubReleaseDraft[GitHub Release draft]
    publish_pypi_yml[publish-pypi.yml]
    PyPI[PyPI easycord project]

    Developer -->|merge PRs with labels| ReleaseDrafter
    Developer -->|run bump_version.py 5.X.Y| bump_version_py
    bump_version_py -->|self validate| check_release_metadata_py
    Developer -->|push release branch and open PR| GitHubReleaseDraft
    ReleaseDrafter -->|maintain draft from labels| GitHubReleaseDraft
    Developer -->|publish drafted release| publish_pypi_yml
    publish_pypi_yml -->|build wheel and sdist, upload| PyPI
Loading

File-Level Changes

Change Details Files
Introduce a comprehensive development workflow guide that documents fix, feature, and release processes, including local gates and CI expectations.
  • Create docs/development-workflow.md with sections for setup, local validation commands, bug-fix workflow, feature-surface decision tree, release procedure, and key invariants.
  • Document how existing tooling and infrastructure are meant to be used: pytest, ruff, check_release_metadata.py, verify_plugin_tests.py, ServerConfigStore.mutate, bump_version.py, Release Drafter labels, and publish-pypi.yml.
  • Clarify expectations for regression tests, docs, changelog entries, and PR labels for new features and releases.
docs/development-workflow.md
Expose the new development workflow guide from contributor and documentation entry points so it is discoverable.
  • Add a pointer in CONTRIBUTING.md that distinguishes standards/conventions from end-to-end workflows and links to the new guide.
  • Add a new goal row in the first table in docs/README.md pointing contributors to the Development Workflow guide.
  • Add a new reference row in the second table in docs/README.md describing the Development Workflow doc as fix/feature/release workflows.
CONTRIBUTING.md
docs/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@rolling-codes, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: b312a588-6652-4807-9785-1fd9030d412e

📥 Commits

Reviewing files that changed from the base of the PR and between 2799fdc and b461162.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • docs/README.md
  • docs/development-workflow.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/development-workflow

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The hard-coded >=20 tests per plugin threshold in the local gate and feature sections is likely to drift from CI rules over time; consider centralizing this limit (e.g., in one doc or config) and referencing it instead of repeating a specific number.
  • The invariants section duplicates content from CONTRIBUTING.md#key-invariants-easy-to-get-wrong; to avoid future divergence, consider either linking directly to that section only or clearly indicating this is a curated subset that doesn’t need to stay in strict sync.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The hard-coded `>=20 tests per plugin` threshold in the local gate and feature sections is likely to drift from CI rules over time; consider centralizing this limit (e.g., in one doc or config) and referencing it instead of repeating a specific number.
- The invariants section duplicates content from `CONTRIBUTING.md#key-invariants-easy-to-get-wrong`; to avoid future divergence, consider either linking directly to that section only or clearly indicating this is a curated subset that doesn’t need to stay in strict sync.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@rolling-codes rolling-codes merged commit cf79f5b into main Jul 11, 2026
14 checks passed
@rolling-codes rolling-codes deleted the docs/development-workflow branch July 11, 2026 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants