From 761f122d863f39a5267ee02d66b9870b3b8bedcf Mon Sep 17 00:00:00 2001 From: Tai <139771199+taieeuu@users.noreply.github.com> Date: Thu, 24 Oct 2024 11:31:01 +0800 Subject: [PATCH] Fix CONTRIBUTING.md and update (#5873) * Fix CONTRIBUTING.md and update Signed-off-by: taieeuu * merge Signed-off-by: Future-Outlier * mrege Signed-off-by: Future-Outlier --------- Signed-off-by: taieeuu Signed-off-by: Future-Outlier Co-authored-by: Future-Outlier --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f380c33d93..62daf171f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)