Skip to content

Commit

Permalink
Fix CONTRIBUTING.md and update (#5873)
Browse files Browse the repository at this point in the history
* Fix CONTRIBUTING.md and update

Signed-off-by: taieeuu <[email protected]>

* merge

Signed-off-by: Future-Outlier <[email protected]>

* mrege

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: taieeuu <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Future-Outlier <[email protected]>
  • Loading branch information
taieeuu and Future-Outlier authored Oct 24, 2024
1 parent 6785887 commit 761f122
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# 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/index.html) section of the documentation.

## Recommendation Order (For Beginners)
* Setup dev environment
* Read the following and run at least 5 examples. Pay close attention to the generated outputs, the Graph view, task
logs, etc. Repeat with as many examples as you need to have an initial understanding of what an execution looks like:
* 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 [ImageSpec to push images to localhost for development](https://docs.flyte.org/en/latest/user_guide/customizing_dependencies/imagespec.html#image-spec-example)

0 comments on commit 761f122

Please sign in to comment.