docs: add CONTRIBUTING.md with Releasing section#984
Conversation
Co-Authored-By: AJ Steers <aj@airbyte.io>
🤖 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 PyAirbyte VersionYou can test this version of PyAirbyte using the following: # Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1771615309-add-releasing-docs' pyairbyte --help
# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1771615309-add-releasing-docs'PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful ResourcesCommunity SupportQuestions? Join the #pyairbyte channel in our Slack workspace. |
📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Would you like a short PR checklist added to the CONTRIBUTING.md to streamline reviews, wdyt? 🚥 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 7: The CONTRIBUTING.md "Releasing Guide" link currently points to an
upstream doc that 404s; add a short inline note in CONTRIBUTING.md next to the
"Releasing Guide" link (or immediately above/below it) stating that the upstream
docs (PR `#41`) are pending merge and that this PR is blocked until that upstream
PR lands, and also include the upstream URL
(https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md)
and the upstream PR number to make the dependency explicit for maintainers and
reviewers; alternatively add the same note to the PR description or a checklist
comment so the merge blocker is discoverable.
Co-Authored-By: AJ Steers <aj@airbyte.io>
There was a problem hiding this comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@CONTRIBUTING.md`:
- Line 9: The CONTRIBUTING.md contains a Releasing Guide link that currently
404s because it points to an upstream PR
(aaronsteers/semantic-pr-release-drafter#41); update the link in CONTRIBUTING.md
(the "Releasing Guide" reference) to a valid URL before merging—either replace
it with the resolved upstream URL once that PR is merged, point it to the local
docs/releasing.md file in this repo if you’ve vendorized the guide, or remove
the broken link and add a TODO referencing the upstream PR number for later
verification.
docs: add CONTRIBUTING.md with Releasing section
Summary
Adds a new
CONTRIBUTING.mdto PyAirbyte with a## 🚀 Releasingsection that includes:semantic-pr-release-drafterfor more detailThe upstream releasing guide is being added in aaronsteers/semantic-pr-release-drafter#41 — that PR should land first so the link resolves.
Updates since last revision
## 🚀 Releasingper reviewer feedbackReview & Testing Checklist for Human
airbytehq/PyAirbyte, not another repo from the batch.Notes
This is one of 9 consumer-repo PRs adding a Releasing section to
CONTRIBUTING.md, all linking to the same shared guide. The upstream guide PR is aaronsteers/semantic-pr-release-drafter#41.Requested by: Aaron ("AJ") Steers (@aaronsteers)
Devin session
Summary by CodeRabbit