docs: delete duplicate root CONTRIBUTING.md, add release-drafter ref to RELEASES.md#917
Conversation
…release-drafter references 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 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/1771619414-fix-contributing-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/1771619414-fix-contributing-docsPR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
|
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
Ditto. Delete this dupe file.
…d as canonical Co-Authored-By: AJ Steers <aj@airbyte.io>
docs/CONTRIBUTING.md
Outdated
| This project uses [`semantic-pr-release-drafter`](https://github.com/aaronsteers/semantic-pr-release-drafter) for automated release management. For more information, see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md). | ||
|
|
||
| Please also see the [Release Management](./RELEASES.md) guide for repo-specific information on how to perform releases and pre-releases. |
There was a problem hiding this comment.
Don't put this content here, since we have a dedicated page already for releases. Put the content into RELEASES.md - or if there's no need for that page anymore (because our new docs cover everything) delete it, in which case the content can live here.
There was a problem hiding this comment.
Done — reverted docs/CONTRIBUTING.md back to its original text (just links to RELEASES.md), deleted the duplicate root CONTRIBUTING.md, and moved the semantic-pr-release-drafter reference into docs/RELEASES.md at the top of the page. The existing repo-specific content in RELEASES.md is preserved.
… to RELEASES.md Co-Authored-By: AJ Steers <aj@airbyte.io>
docs: delete duplicate root CONTRIBUTING.md, add release-drafter ref to RELEASES.md
Summary
Follow-up to #916, which added a root-level
CONTRIBUTING.mdwith a Releasing section but missed the existing detailed contributing docs atdocs/CONTRIBUTING.mdanddocs/RELEASES.md.This PR:
CONTRIBUTING.md(the canonical guide already lives atdocs/CONTRIBUTING.mdand is linked fromREADME.mdline 30)semantic-pr-release-drafterreference to the top ofdocs/RELEASES.md, which is the dedicated releases page for this repoUpdates since last revision
Per reviewer feedback:
CONTRIBUTING.mdis now deleted instead of kept as a redirect (it was a duplicate that shouldn't have been created)docs/CONTRIBUTING.md— its Release Management section already just links toRELEASES.md, which is the right place for release contentsemantic-pr-release-drafterreference intodocs/RELEASES.mdinsteadReview & Testing Checklist for Human
README.mdline 30 still links todocs/CONTRIBUTING.mdcorrectly (no broken contributor onboarding path after root file deletion)semantic-pr-release-drafterblurb at the top ofdocs/RELEASES.mdreads well alongside the existing publishing instructions below itNotes
Requested by: Aaron ("AJ") Steers (@aaronsteers)
Devin session