-
Notifications
You must be signed in to change notification settings - Fork 80
[hooks] [code_assets] README.md #2685
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
Conversation
PR HealthBreaking changes ✔️
This check can be disabled by tagging the PR with API leaks ✔️The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
This check can be disabled by tagging the PR with License Headers ✔️
All source files should start with a license header. Unrelated files missing license headers
This check can be disabled by tagging the PR with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a nice improvement to the readme to make the packages more approachable! 🚀
LGTM
I think it is a good idea to link to the code_asset examples from the hooks readme, as you have done in this PR. I would keep the examples in the source tree, though. They are still useful to demonstrate individual features. I would add a link from hooks/examples/README.md to the more comprehensive examples in code_assets, though. |
This revamps the READMEs to include
Side note, I'm thinking we might want to completely remove the examples from
package:hooks
and simply link to the examples inpackage:code_assets
. The examples inpackage:hooks
are rather artificial and more of a feature showcase, which makes them less understandable.Bug: