Skip to content

docs: add CONTRIBUTING.md with Releasing section#984

Merged
Aaron ("AJ") Steers (aaronsteers) merged 2 commits into
mainfrom
devin/1771615309-add-releasing-docs
Feb 20, 2026
Merged

docs: add CONTRIBUTING.md with Releasing section#984
Aaron ("AJ") Steers (aaronsteers) merged 2 commits into
mainfrom
devin/1771615309-add-releasing-docs

Conversation

@aaronsteers

@aaronsteers Aaron ("AJ") Steers (aaronsteers) commented Feb 20, 2026

Copy link
Copy Markdown
Member

docs: add CONTRIBUTING.md with Releasing section

Summary

Adds a new CONTRIBUTING.md to PyAirbyte with a ## 🚀 Releasing section that includes:

  • Inline release instructions: click "Edit" on the latest draft from the releases page, then click "Publish release"
  • A link to the shared Releasing Guide in semantic-pr-release-drafter for more detail

The 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

  • Updated heading to ## 🚀 Releasing per reviewer feedback
  • Added inline release instructions with a direct link to PyAirbyte's releases page
  • Added ℹ️ callout linking to the detailed Releasing Guide
  • Corrected sentence structure per reviewer feedback

Review & Testing Checklist for Human

  • Verify the releases page link points to the correct repo. It should go to airbytehq/PyAirbyte, not another repo from the batch.
  • Decide if this CONTRIBUTING.md is too bare-bones for PyAirbyte. It currently only has a Releasing section. You may want additional sections (dev setup, testing, PR guidelines) added in a follow-up.
  • Verify the Releasing Guide link resolves after aaronsteers/semantic-pr-release-drafter#41 is merged.

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

  • Documentation
    • Added a CONTRIBUTING guide to help community members participate, covering how to contribute, review expectations, and submission guidelines.
    • Added a Releasing subsection outlining the project's release procedures and links to the release workflow documentation.

Open with Devin

Co-Authored-By: AJ Steers <aj@airbyte.io>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions

Copy link
Copy Markdown

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

Testing This PyAirbyte Version

You 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 Commands

Airbyte Maintainers can execute the following slash commands on your PR:

  • /fix-pr - Fixes most formatting and linting issues
  • /uv-lock - Updates uv.lock file
  • /test-pr - Runs tests with the updated PyAirbyte
  • /prerelease - Builds and publishes a prerelease version to PyPI
📚 Show Repo Guidance

Helpful Resources

Community Support

Questions? Join the #pyairbyte channel in our Slack workspace.

📝 Edit this welcome message.

@coderabbitai

coderabbitai Bot commented Feb 20, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

A new CONTRIBUTING.md file is added with contribution guidelines and a Releasing subsection that references the semantic-pr-release-drafter tool and links to its releasing guide.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added new contribution guidelines including a "Contributing" section and a "Releasing" subsection that references semantic-pr-release-drafter and its releasing guide.

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)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a new CONTRIBUTING.md file with a Releasing section, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch devin/1771615309-add-releasing-docs

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 and usage tips.

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

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.

Comment thread CONTRIBUTING.md Outdated
@github-actions

github-actions Bot commented Feb 20, 2026

Copy link
Copy Markdown

PyTest Results (Fast Tests Only, No Creds)

343 tests  ±0   343 ✅ ±0   5m 41s ⏱️ +6s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 790e0d6. ± Comparison against base commit e48484f.

♻️ This comment has been updated with latest results.

Co-Authored-By: AJ Steers <aj@airbyte.io>

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

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

@devin-ai-integration devin-ai-integration Bot marked this pull request as ready for review February 20, 2026 20:13

@devin-ai-integration devin-ai-integration 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.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

@github-actions

Copy link
Copy Markdown

PyTest Results (Full)

413 tests  ±0   396 ✅ ±0   24m 13s ⏱️ +7s
  1 suites ±0    17 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 790e0d6. ± Comparison against base commit e48484f.

@aaronsteers Aaron ("AJ") Steers (aaronsteers) merged commit fa52519 into main Feb 20, 2026
24 checks passed
@aaronsteers Aaron ("AJ") Steers (aaronsteers) deleted the devin/1771615309-add-releasing-docs branch February 20, 2026 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant