|
1 | 1 | # Contributing to Flyte |
2 | 2 |
|
3 | | -For information related to contributing to Flyte, please check out the [Contributing to Flyte](https://docs.flyte.org/en/latest/community/contribute/index.html) section of the documentation. |
4 | | - |
5 | | -## Recommendation Order (For Beginners) |
6 | | -* Setup dev environment |
7 | | -* Read the following and run at least 5 examples. Pay close attention to the generated outputs, the Graph view, task |
8 | | - logs, etc. Repeat with as many examples as you need to have an initial understanding of what an execution looks like: |
9 | | - * https://docs.flyte.org/en/latest/user_guide/introduction.html |
10 | | - * https://docs.flyte.org/en/latest/flytesnacks/userguide.html |
11 | | -* Finish reading the [Concepts](https://docs.flyte.org/en/latest/user_guide/concepts/main_concepts/index.html) |
12 | | -* Finish reading the [Control Plane](https://docs.flyte.org/en/latest/user_guide/concepts/control_plane/index.html) |
13 | | -* Finish reading the [Component Architecture](https://docs.flyte.org/en/latest/user_guide/concepts/component_architecture/index.html) |
14 | | -* Choose 2 good first issues from the following and start solving them with the knowledge you have read. |
15 | | -* Familiar with using [ImageSpec to push images to localhost for development](https://docs.flyte.org/en/latest/user_guide/customizing_dependencies/imagespec.html#image-spec-example) |
| 3 | +First off, thanks for taking the time to contribute! ❤️ |
| 4 | + |
| 5 | +All types of contributions are encouraged and valued. See the [Table of Contents](#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. 🎉 |
| 6 | + |
| 7 | +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: |
| 8 | + |
| 9 | +- Star the project |
| 10 | +- Post on X or Linkedin about Flyte `#flyte |
| 11 | +- Mention the project at local meetups and tell your friends/colleagues |
| 12 | + |
| 13 | +## Table of Contents |
| 14 | + |
| 15 | +- [Code of Conduct](#code-of-conduct) |
| 16 | +- [I Have a Question](#i-have-a-question) |
| 17 | +- [I Want To Contribute](#i-want-to-contribute) |
| 18 | + - [Code Contributors](#code-contributors) |
| 19 | + - [Recommendation Order (For Beginners)](#recommendation-order-for-beginners) |
| 20 | + - [Reporting Bugs](#reporting-bugs) |
| 21 | + - [Feature Requests](#feature-requests) |
| 22 | + - [Improving The Documentation](#improving-the-documentation) |
| 23 | + - [Improving The Design](#improving-the-design) |
| 24 | + - [Publish a Blog Post or Case Study](#publish-a-blog-post-or-case-study) |
| 25 | + - [Commit Messages](#commit-messages) |
| 26 | +- [Pull requests](#pull-requests) |
| 27 | +- [Contributor Ladder](#contributor-ladder) |
| 28 | + |
| 29 | +## Code of Conduct |
| 30 | + |
| 31 | +This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/flyteorg/flyte/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior |
| 32 | +to [security@union.ai](mailto:security@union.ai). |
| 33 | + |
| 34 | +## I Have a Question |
| 35 | + |
| 36 | +If you need clarification after reading this document, we encourage you to join our [slack](https://slack.flyte.org/) workspace and join channels [#flyte-support](https://flyte-org.slack.com/archives/CP2HDHKE1) and [#contribute](https://flyte-org.slack.com/archives/C04NJPLRWUX) channel. |
| 37 | + |
| 38 | +## I Want To Contribute |
| 39 | + |
| 40 | +### Code Contributors |
| 41 | + |
| 42 | +We’re excited that you’re interested in contributing code to Flyte! Before you start, please take a look at our [Quickstart](https://www.union.ai/docs/v2/flyte/user-guide/quickstart/) docs, it includes setup instructions, build steps, and details on running your first workflow locally. |
| 43 | + |
| 44 | +#### Recommendation Order (For Beginners) |
| 45 | + |
| 46 | +- Finish reading [Core Concepts](https://www.union.ai/docs/v2/flyte/user-guide/core-concepts/) |
| 47 | +- Finish reading [Connecting a Cluster](https://www.union.ai/docs/v2/flyte/user-guide/connecting-to-a-cluster/) |
| 48 | +- Finish reading [Projects and Domain](https://www.union.ai/docs/v2/flyte/user-guide/projects-and-domains/) |
| 49 | +- Finish reading [From Flyte 1 to Flyte 2](https://www.union.ai/docs/v2/flyte/user-guide/flyte-2/) |
| 50 | + |
| 51 | +### Reporting Bugs |
| 52 | + |
| 53 | +Please use our issues templates that provide hints on what information we need to help you. |
| 54 | + |
| 55 | +> 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](mailto:security@union.ai) or use the Report a security vulnerability issue template. |
| 56 | +
|
| 57 | +### Feature Requests |
| 58 | + |
| 59 | +Suggest an idea for the project by using the [Issues template](https://github.com/flyteorg/flyte/issues) 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](https://slack.flyte.org/) and ask there. |
| 60 | + |
| 61 | +Unsure if your contribution is “small”, “large” or whether it fits into the project's goal? Kindly start a quick [discussion](https://github.com/flyteorg/flyte/discussions) on github. |
| 62 | + |
| 63 | +### Improving The Documentation |
| 64 | + |
| 65 | +If you notice outdated information or areas that could be clarified, kindly start a discussion in the [contribute](https://flyte-org.slack.com/archives/C04NJPLRWUX) channel on slack. For more information, please checkout [Contributing to documentation](https://www.union.ai/docs/v2/flyte/community/#contributing-to-documentation). |
| 66 | + |
| 67 | +### Improving The Design |
| 68 | + |
| 69 | +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. |
| 70 | + |
| 71 | +### Publish a Blog Post or Case Study |
| 72 | + |
| 73 | +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](https://flyte-org.slack.com/archives/C04NJPLRWUX) channel on slack, summarizing your post or case study, with a link to the full content. |
| 74 | + |
| 75 | +### Commit Messages |
| 76 | + |
| 77 | +Writing clear and consistent commit messages helps maintainers understand the purpose of your changes. A good commit message should: |
| 78 | + |
| 79 | +- Be written in the present tense (e.g., Add new feature, not Added new feature) |
| 80 | + |
| 81 | +- Be short (50 characters or less for the summary line) |
| 82 | + |
| 83 | +- Include additional context in the body if needed |
| 84 | + |
| 85 | +- Reference related issue numbers (e.g., Fixes `#123) |
| 86 | + |
| 87 | +- Keep each commit focused on one logical change |
| 88 | + |
| 89 | +## Pull Requests |
| 90 | + |
| 91 | +When you’re ready to contribute your changes, follow these steps to create a clear and reviewable pull request: |
| 92 | + |
| 93 | +- Push your changes to your fork: |
| 94 | + |
| 95 | + ```bash |
| 96 | + git push origin your-branch-name |
| 97 | + ``` |
| 98 | + |
| 99 | +- Open a Pull Request against the main Flyte Code repository. |
| 100 | + |
| 101 | +- Select "Compare across forks" and choose your fork and branch. |
| 102 | + |
| 103 | +- Fill out the PR template with: |
| 104 | + |
| 105 | +- A clear description of your changes |
| 106 | + |
| 107 | + - Any related issues (e.g., “changed `#123”). |
| 108 | +
|
| 109 | + - Testing steps or screenshots (if applicable) |
| 110 | +
|
| 111 | + - Notes for reviewers, if special attention is needed. |
| 112 | +
|
| 113 | +For more context, kindly read the official [Before Submitting Your PR](https://www.union.ai/docs/v1/flyte/community/contributing-code/#before-submitting-your-pr) docs. |
| 114 | +
|
| 115 | +## Contributor Ladder |
| 116 | +
|
| 117 | +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](https://github.com/flyteorg/community/blob/main/GOVERNANCE.md#community-roles-and-path-to-maintainership). |
| 118 | +
|
| 119 | +
|
| 120 | +Your contributions, big or small help make Flyte better for everyone!🫶 |
| 121 | +
|
| 122 | +## References |
| 123 | +
|
| 124 | +This document was adapted from [https://contributing.md](https://contributing.md/)! |
0 commit comments