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.

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

merged 5 commits into from
Oct 24, 2024

Conversation

taieeuu
Copy link
Contributor

@taieeuu taieeuu commented Oct 20, 2024

Tracking issue

Reference #5868

Why are the changes needed?

Fix error link.And add the Recommendation Order for begineers

What changes were proposed in this pull request?

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 try to run 10 examples
    * 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

Check all the applicable boxes

  • [ x ] I updated the documentation accordingly.
  • [ x ] All new and existing tests passed.
  • [ x ] All commits are signed-off.

Related PRs

Copy link

welcome bot commented Oct 20, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

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!

CONTRIBUTING.md Outdated

## Recommendation Order (For Beginners)
* 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?

Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.81%. Comparing base (595c552) to head (60b0d31).
Report is 14 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5873      +/-   ##
==========================================
- Coverage   36.81%   36.81%   -0.01%     
==========================================
  Files        1309     1309              
  Lines      130893   130895       +2     
==========================================
  Hits        48185    48185              
- Misses      78526    78528       +2     
  Partials     4182     4182              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.03% <ø> (ø)
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.59% <ø> (-0.01%) ⬇️
unittests-flytepropeller 43.00% <ø> (ø)
unittests-flytestdlib 55.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CONTRIBUTING.md Outdated
* 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

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
@Future-Outlier Future-Outlier enabled auto-merge (squash) October 23, 2024 02:39
@Future-Outlier Future-Outlier merged commit 761f122 into flyteorg:master Oct 24, 2024
50 checks passed
Copy link

welcome bot commented Oct 24, 2024

Congrats on merging your first pull request! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants