Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (72 loc) · 6.71 KB

CONTRIBUTING.md

File metadata and controls

124 lines (72 loc) · 6.71 KB

Contributing to Flyte

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for the team and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

If you don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Post on X or Linkedin about Flyte `#flyte
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to security@union.ai.

I Have a Question

If you need clarification after reading this document, we encourage you to join our slack workspace and join channels #flyte-support and #contribute channel.

I Want To Contribute

Code Contributors

We’re excited that you’re interested in contributing code to Flyte! Before you start, please take a look at our Quickstart docs, it includes setup instructions, build steps, and details on running your first workflow locally.

Recommendation Order (For Beginners)

Reporting Bugs

Please use our issues templates that provide hints on what information we need to help you.

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to security@union.ai or use the Report a security vulnerability issue template.

Feature Requests

Suggest an idea for the project by using the Issues template and choose your desired option and kindly provide as much context as you can about what you're running into. Do not open issues for questions or support, instead join our slack workspace and ask there.

Unsure if your contribution is “small”, “large” or whether it fits into the project's goal? Kindly start a quick discussion on github.

Improving The Documentation

If you notice outdated information or areas that could be clarified, kindly start a discussion in the contribute channel on slack. For more information, please checkout Contributing to documentation.

Improving The Design

Design contributions are welcome! To ensure smooth collaboration, please use the UI Feature Request Template when opening a design-related issue. This helps us gather the right context (such as wireframes, mockups, or visual references) and maintain a consistent design language across the project. Feedback and iterations are highly encouraged, design is always a shared process.

Publish a Blog Post or Case Study

We love hearing how people use or extend Flyte in their own projects. If you’ve written about your experience, we’re happy to review it! To share your work, please start a discussion in the #contribute channel on slack, summarizing your post or case study, with a link to the full content.

Commit Messages

Writing clear and consistent commit messages helps maintainers understand the purpose of your changes. A good commit message should:

  • Be written in the present tense (e.g., Add new feature, not Added new feature)

  • Be short (50 characters or less for the summary line)

  • Include additional context in the body if needed

  • Reference related issue numbers (e.g., Fixes `#123)

  • Keep each commit focused on one logical change

Pull Requests

When you’re ready to contribute your changes, follow these steps to create a clear and reviewable pull request:

  • Push your changes to your fork:

    git push origin your-branch-name

  • Open a Pull Request against the main Flyte Code repository.

  • Select "Compare across forks" and choose your fork and branch.

  • Fill out the PR template with:

  • A clear description of your changes

    • Any related issues (e.g., “changed `#123”).

    • Testing steps or screenshots (if applicable)

    • Notes for reviewers, if special attention is needed.

For more context, kindly read the official Before Submitting Your PR docs.

Contributor Ladder

The Flyte Contributor Ladder is a key resource for understanding how to grow within Flyte, outlining expectations, responsibilities, and progression across roles. It helps create transparency, recognize contributions, and ensure a sustainable and inclusive path for community members to deepen their impact. Read more.

Your contributions, big or small help make Flyte better for everyone!🫶

References

This document was adapted from https://contributing.md!