tilt-extensions
tilt-extensions copied to clipboard
tilt-dev
Make README.md required for all future extensions
A great trend was started with #9 including a README.md since then many plugins have also adopted this. I think it's not only a great way for future users to see it but it makes reviewing the methods/usage much easier than just looking at the raw code.
We should obviously update the contributing guide.
It would be epic if we also added a CI step that validated that the readme existed in all folders to give a helpful hint.
What are your thoughts?
Thanks @drubin for the idea. I've added https://github.com/tilt-dev/tilt.build/commit/a2372f7f5f9028f0a3a9b8f5d527fca5882b46b4 to the contributing guide and updated the description in https://github.com/tilt-dev/tilt/issues/3188 to include the CI step you mentioned. I'll close this issue then so we can all follow up in https://github.com/tilt-dev/tilt/issues/3188 for any next steps. Feel free to suggest ideas / contribute further. Thanks!
@victorwuky I am happy you agree. But Why would you merge these 2 issues? This is pretty simple copy change and a few lines of bash the other is a giant big issue with out a clear defined outcome.
I feel like bundling them will make this trivial fix get lost. That ticket is still from start of April and I don't see it being fixed soon.
This issue I planned on submitting a PR for it but now I don't really want to touch the complex topic of entire dev workflows.
I would suggest linking them and leaving this open.
This issue I planned on submitting a PR for it but now I don't really want to touch the complex topic of entire dev workflows.
I would suggest linking them and leaving this open.
@drubin : Re-opening. Thanks for letting me know.