Skip to content
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.

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

Update plugin contribution guidelines #6212

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

davidmirror-ops
Copy link
Contributor

@davidmirror-ops davidmirror-ops commented Feb 3, 2025

Tracking issue

Why are the changes needed?

Implement community plugins RFC by updating plugin contribution guidelines

What changes were proposed in this pull request?

How was this patch tested?

Labels

Please add one or more of the following labels to categorize your PR:

  • added: For new features.
  • changed: For changes in existing functionality.
  • deprecated: For soon-to-be-removed features.
  • removed: For features being removed.
  • fixed: For any bug fixed.
  • security: In case of vulnerabilities

This is important to improve the readability of release notes.

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Summary by Bito

Documentation update that introduces new guidelines for community plugin contributions. The changes implement the community plugins RFC by adding detailed instructions for integration contributions. This enhancement aims to streamline the process for community members to contribute integrations to the project.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

@davidmirror-ops davidmirror-ops added the added Merged changes that add new functionality label Feb 3, 2025
@flyte-bot
Copy link
Collaborator

flyte-bot commented Feb 3, 2025

Code Review Agent Run #8f92d5

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 81141d1..81141d1
    • docs/community/contribute/index.rst
  • Files skipped - 1
    • docs/community/contribute/contribute_integrations.md - Reason: Filter setting
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Collaborator

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Documentation - Plugin Contribution Guidelines Update

index.rst - Added new section for contributing integrations documentation

Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.90%. Comparing base (27c9edd) to head (81141d1).
Report is 30 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6212      +/-   ##
==========================================
- Coverage   37.01%   36.90%   -0.12%     
==========================================
  Files        1317     1317              
  Lines      132523   134061    +1538     
==========================================
+ Hits        49060    49479     +419     
- Misses      79217    80289    +1072     
- Partials     4246     4293      +47     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 52.48% <ø> (-1.75%) ⬇️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.33% <ø> (+0.04%) ⬆️
unittests-flyteidl 7.23% <ø> (-0.01%) ⬇️
unittests-flyteplugins 53.87% <ø> (+0.02%) ⬆️
unittests-flytepropeller 42.73% <ø> (+0.09%) ⬆️
unittests-flytestdlib 55.35% <ø> (+0.16%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@eapolinario eapolinario left a comment

Choose a reason for hiding this comment

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

awesome, thanks!

Before we merge this though we will need a few changes in flytekit, specifically to implement this idea of having a contrib submodule. We can dry-run this with one of our old integrations (just so we can make sure it works and people have a model to use as a base), maybe https://github.com/flyteorg/flytekit/tree/master/plugins/flytekit-sqlalchemy?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
added Merged changes that add new functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants