Skip to content

Add code structure and a few other links to CONTRIBUTING.md #9793

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

Merged
merged 3 commits into from
Apr 7, 2025

Conversation

larryliu0820
Copy link
Contributor

@larryliu0820 larryliu0820 commented Apr 1, 2025

As titled. This PR mainly adds the mapping between our code structure to the documentations/tutorials. Also a few other touch-ups.

cc @mergennachin @byjlw

As titled. This PR mainly adds the mapping between our code structure to the documentations/tutorials. Also a few other touch-ups.
Copy link

pytorch-bot bot commented Apr 1, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9793

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (1 Unrelated Failure)

As of commit 86d3ba8 with merge base 7d35c68 (image):

FLAKY - The following job failed but was likely due to flakiness present on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 1, 2025
…n README.md

Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
@larryliu0820
Copy link
Contributor Author

@mergennachin merged, thanks to AI coding tool :)

Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
@larryliu0820 larryliu0820 added module: doc Issues related to documentation, both in docs/ and inlined in code release notes: build Changes related to build, including dependency upgrades, build flags, optimizations, etc. labels Apr 2, 2025
@byjlw
Copy link
Contributor

byjlw commented Apr 2, 2025

I think we'll get more contributors if we take the hand-holding approach lightning took with screenshots and such.

Thinking people contributing to open source for the very first time.

Seasoned contributors can breeze right on by.

We could even have a section "beginnings guide to open source contributions"
some people may have years of development experience but are using git for the very first time

https://devblog.pytorchlightning.ai/quick-contribution-guide-86d977171b3a

@larryliu0820
Copy link
Contributor Author

I think we'll get more contributors if we take the hand-holding approach lightning took with screenshots and such.

Thinking people contributing to open source for the very first time.

Seasoned contributors can breeze right on by.

We could even have a section "beginnings guide to open source contributions" some people may have years of development experience but are using git for the very first time

https://devblog.pytorchlightning.ai/quick-contribution-guide-86d977171b3a

Thanks for the link, it's inspiring. I can try to add something similar

@larryliu0820 larryliu0820 merged commit 789799b into main Apr 7, 2025
81 of 84 checks passed
@larryliu0820 larryliu0820 deleted the contributing branch April 7, 2025 18:57
@larryliu0820
Copy link
Contributor Author

@pytorchbot cherry-pick --onto release/0.6 -c docs

@larryliu0820
Copy link
Contributor Author

@pytorchbot cherry-pick --onto release/0.6 -c docs

pytorchbot pushed a commit that referenced this pull request Apr 8, 2025
As titled. This PR mainly adds the mapping between our code structure to
the documentations/tutorials. Also a few other touch-ups.

cc @mergennachin @byjlw

---------

Co-authored-by: Mengwei Liu <mengweiliu@Mengweis-Mac-Studio.local>
(cherry picked from commit 789799b)
@pytorchbot
Copy link
Collaborator

Cherry picking #9793

The cherry pick PR is at #9962 The following tracker issues are updated:

Details for Dev Infra team Raised by workflow job

kirklandsign pushed a commit that referenced this pull request Apr 11, 2025
As titled. This PR mainly adds the mapping between our code structure to
the documentations/tutorials. Also a few other touch-ups.



cc @mergennachin @byjlw

---------

Co-authored-by: Mengwei Liu <mengweiliu@Mengweis-Mac-Studio.local>
keyprocedure pushed a commit to keyprocedure/executorch that referenced this pull request Apr 21, 2025
…9793)

As titled. This PR mainly adds the mapping between our code structure to
the documentations/tutorials. Also a few other touch-ups.



cc @mergennachin @byjlw

---------

Co-authored-by: Mengwei Liu <mengweiliu@Mengweis-Mac-Studio.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. module: doc Issues related to documentation, both in docs/ and inlined in code release notes: build Changes related to build, including dependency upgrades, build flags, optimizations, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants