docs: add CONTRIBUTING.md with Releasing section#916
Merged
Aaron ("AJ") Steers (aaronsteers) merged 2 commits intomainfrom Feb 20, 2026
Merged
docs: add CONTRIBUTING.md with Releasing section#916Aaron ("AJ") Steers (aaronsteers) merged 2 commits intomainfrom
Aaron ("AJ") Steers (aaronsteers) merged 2 commits intomainfrom
Conversation
Co-Authored-By: AJ Steers <aj@airbyte.io>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This CDK VersionYou can test this version of the CDK using the following: # Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/airbyte-python-cdk.git@devin/1771615309-add-releasing-docs#egg=airbyte-python-cdk[dev]' --help
# Update a connector to use the CDK from this branch ref:
cd airbyte-integrations/connectors/source-example
poe use-cdk-branch devin/1771615309-add-releasing-docsPR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
|
Co-Authored-By: AJ Steers <aj@airbyte.io>
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Contributor
📝 WalkthroughWalkthroughA new CONTRIBUTING.md file is added to document contribution guidelines for the Airbyte Python CDK, including release process instructions using semantic-pr-release-drafter and directions for publishing release drafts. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
1-9: Worth expanding the document over time with other contribution topics — just a thought for future iterations.The file is currently scoped to releasing only. Common sections like development setup, running tests, coding standards, and the PR process would make this a more complete guide for first-time contributors. No action needed now if the intent is to grow this incrementally.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 1 - 9, CONTRIBUTING.md currently only documents the release process; add additional top-level sections to help first-time contributors by creating headers and content for Development setup (dependencies, virtualenv/venv, how to install with pip, example commands), Running tests (how to run unit/integration tests, pytest commands, CI notes), Coding standards (formatting, linting, pre-commit hooks, reference to any style guides), and PR process (branching, commit message format, how to open a PR, review/CI expectations) so the doc becomes a fuller contributor guide; update the existing "Releasing" section with a brief cross-reference and ensure each new section includes example commands and links to relevant files/scripts in the repo (use these section titles to locate and edit the file).
7-7: Consider whether "Publish release" can be clicked directly without going through "Edit" first — curious what you think?GitHub's draft release UI also surfaces a "Publish release" button without requiring "Edit" first. Dropping the
"Edit" →step might make the instructions slightly more concise, but if the current wording reflects the actual intended workflow (e.g. to review the draft before publishing), it's totally fine to keep it.✏️ Simplified phrasing (if "Edit" is not strictly required)
-This project uses [`semantic-pr-release-drafter`](https://github.com/aaronsteers/semantic-pr-release-drafter) for automated release management. To release, simply click "`Edit`" on the latest release draft from the [releases page](https://github.com/airbytehq/airbyte-python-cdk/releases), and then click "`Publish release`". This publish operation will trigger all necessary downstream publish operations. +This project uses [`semantic-pr-release-drafter`](https://github.com/aaronsteers/semantic-pr-release-drafter) for automated release management. To release, open the latest release draft from the [releases page](https://github.com/airbytehq/airbyte-python-cdk/releases) and click "`Publish release`". This publish operation will trigger all necessary downstream publish operations.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 7, The sentence describing how to publish a draft release currently says to click "Edit" then "Publish release"; update it to reflect the correct GitHub UI/workflow by either removing the "Edit →" step (so it reads "click 'Publish release' on the latest release draft") or clarifying that "Edit" is optional if you need to review the draft before publishing; update the line containing the words "Edit" and "Publish release" in CONTRIBUTING.md accordingly so the instructions are accurate and concise.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 1-9: CONTRIBUTING.md currently only documents the release process;
add additional top-level sections to help first-time contributors by creating
headers and content for Development setup (dependencies, virtualenv/venv, how to
install with pip, example commands), Running tests (how to run unit/integration
tests, pytest commands, CI notes), Coding standards (formatting, linting,
pre-commit hooks, reference to any style guides), and PR process (branching,
commit message format, how to open a PR, review/CI expectations) so the doc
becomes a fuller contributor guide; update the existing "Releasing" section with
a brief cross-reference and ensure each new section includes example commands
and links to relevant files/scripts in the repo (use these section titles to
locate and edit the file).
- Line 7: The sentence describing how to publish a draft release currently says
to click "Edit" then "Publish release"; update it to reflect the correct GitHub
UI/workflow by either removing the "Edit →" step (so it reads "click 'Publish
release' on the latest release draft") or clarifying that "Edit" is optional if
you need to review the draft before publishing; update the line containing the
words "Edit" and "Publish release" in CONTRIBUTING.md accordingly so the
instructions are accurate and concise.
Aaron ("AJ") Steers (aaronsteers)
deleted the
devin/1771615309-add-releasing-docs
branch
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: add CONTRIBUTING.md with Releasing section
Summary
Adds a new
CONTRIBUTING.mdtoairbyte-python-cdkwith a## 🚀 Releasingsection that includes:semantic-pr-release-drafterfor more detailThis is part of a cross-repo effort to ensure all repos using
semantic-pr-release-drafterhave a consistent "Releasing" entry in their CONTRIBUTING.md, pointing to a single source of truth rather than duplicating instructions.The companion PR adding the shared releasing guide itself: aaronsteers/semantic-pr-release-drafter#41
Updates since last revision
## 🚀 Releasingper reviewer feedbackReview & Testing Checklist for Human
airbytehq/airbyte-python-cdk, not another repo.docs/releasing.mdis being added via aaronsteers/semantic-pr-release-drafter#41 — that PR should land first or concurrently to avoid a dead link.Notes
Requested by: Aaron ("AJ") Steers (@aaronsteers)
Devin session
Summary by CodeRabbit