Skip to content

docs: delete duplicate root CONTRIBUTING.md and update release instructions #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Aaron ("AJ") Steers (aaronsteers) wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: delete duplicate root CONTRIBUTING.md and update release instructions #985

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27fe004
docs: link root CONTRIBUTING.md to existing docs and add semantic-pr-…
devin-ai-integration[bot] Feb 20, 2026
560157e
docs: delete duplicate root CONTRIBUTING.md, keep docs/CONTRIBUTING.m…
devin-ai-integration[bot] Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Copy link
Contributor Author

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

Choose a reason for hiding this comment

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

Delete this file. It is a dupe that should not have been created. Merge into docs/CONTRIBUTING.md and make sure docs/CONTRIBUTING.md is linked from the README.md.

Copy link
Contributor

@devin-ai-integration devin-ai-integration bot Feb 20, 2026

Choose a reason for hiding this comment

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

Done — deleted root CONTRIBUTING.md. The docs/CONTRIBUTING.md already has the updated Release section with the semantic-pr-release-drafter link, and README.md already links to docs/CONTRIBUTING.md at line 64.

Devin session

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Thank you for your interest in contributing to PyAirbyte!

For detailed development setup, testing, and documentation guidelines, please see the full [Contributing Guide](./docs/CONTRIBUTING.md).

## 🚀 Releasing

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/PyAirbyte/releases), and then click "`Publish release`". This publish operation will trigger all necessary downstream publish operations.
Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Documentation pages will be generated in the `docs/generated` folder. The `test_

## Release

Releases are published automatically to PyPi in response to a "published" event on a GitHub Release Tag.
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/PyAirbyte/releases), and then click "`Publish release`". This publish operation will trigger all necessary downstream publish operations.

To publish to PyPi, simply [create a GitHub Release](https://github.com/airbytehq/PyAirbyte/releases/new) with the correct version. Once you publish the release on GitHub it will automatically trigger a PyPi publish workflow in GitHub actions.
ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md).
Comment on lines +37 to +39
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 20, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if semantic-pr-release-drafter is referenced in GitHub workflows
rg -rn "semantic-pr-release-drafter" .github/ 2>/dev/null || echo "No matches found in .github/"

Repository: airbytehq/PyAirbyte

Length of output: 208

🏁 Script executed:

#!/bin/bash
# Verify the exact content of docs/CONTRIBUTING.md around lines 37-39
# First, let's see how many lines the file has
wc -l docs/CONTRIBUTING.md

# Then read the relevant section
sed -n '30,45p' docs/CONTRIBUTING.md

Repository: airbytehq/PyAirbyte

Length of output: 1111

🏁 Script executed:

#!/bin/bash
# Check the entire docs/CONTRIBUTING.md to ensure we capture the context
cat -n docs/CONTRIBUTING.md | grep -A 5 -B 5 "semantic-pr-release-drafter"

Repository: airbytehq/PyAirbyte

Length of output: 1079

Pin the Releasing Guide link to a stable ref instead of main.

The Releasing Guide URL targets the main branch of aaronsteers/semantic-pr-release-drafter — if that branch is renamed, the file is moved, or the repo is reorganized, the link silently 404s. Would you consider linking to a specific tag or commit SHA instead?

-ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md).
+ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/<TAG_OR_SHA>/docs/releasing.md).

Additionally, I noticed that semantic-pr-release-drafter isn't explicitly referenced in the workflows (the release workflow uses aaronsteers/n@v1.0.0). Could you confirm the tool is actually configured before these docs land? It would be good to verify the connection between what the docs describe and what's running in the CI.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/CONTRIBUTING.md` around lines 37 - 39, Update the Releasing Guide link
to point to a stable reference (a specific tag or commit SHA) instead of the
main branch by replacing the current URL to the
`aaronsteers/semantic-pr-release-drafter` docs with a tag/commit-based URL; also
verify in your CI/workflows that the tool referenced in the docs
(semantic-pr-release-drafter) is actually configured—check workflow files that
currently reference `aaronsteers/n@v1.0.0` and confirm whether they call
`semantic-pr-release-drafter` (or add the proper action/version) so the docs and
workflows match.


> **Warning**
>
Expand Down