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.

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

Fix CONTRIBUTING.md and update #5873

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Fix CONTRIBUTING.md and update #5873

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4c3f33
Fix CONTRIBUTING.md and update
taieeuu Oct 20, 2024
a9d4603
merge
Future-Outlier Oct 23, 2024
686a2be
Merge branch 'master' into tai
Future-Outlier Oct 23, 2024
4f54f11
mrege
Future-Outlier Oct 23, 2024
60b0d31
Merge branch 'master' into tai
Future-Outlier Oct 23, 2024
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
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Contributing to Flyte

For information related to contributing to Flyte, please check out the [Contributing to Flyte](https://docs.flyte.org/en/latest/community/contribute.html) section of the documentation.
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.

## Recommendation Order (For Beginners)
Copy link
Contributor

Choose a reason for hiding this comment

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

Great, thanks for taking the initiative!

* Setup dev environment
* Read the following and try to run 10 examples
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think we could lower the barrier here? Any number is arbitrary at this point so maybe something like "Run at least one example and pay close attention to effects: generated outputs, the Graph view, tasks logs, etc. Repeat with as many examples as you need to have an initial understanding of what an execution looks like" wdyt?

* https://docs.flyte.org/en/latest/user_guide/introduction.html
* https://docs.flyte.org/en/latest/flytesnacks/userguide.html
* Finish reading the [Concepts](https://docs.flyte.org/en/latest/user_guide/concepts/main_concepts/index.html)
* Finish reading the [Control Plane](https://docs.flyte.org/en/latest/user_guide/concepts/control_plane/index.html)
* Finish reading the [Component Architecture](https://docs.flyte.org/en/latest/user_guide/concepts/component_architecture/index.html)
* Choose 2 good first issues from the following and start solving them with the knowledge you have read.
* Familiar with using DOCKERFILE to push images to localhost for development
Copy link
Contributor

Choose a reason for hiding this comment

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

While not the examples follow it today, we try to make ImageSpec first, and trying to avoid Dockerfiles

Loading