-
Notifications
You must be signed in to change notification settings - Fork 40
Add CONTRIBUTING.md
in vscode extension and top-level install commands
#753
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
Cool! I like this tool too! Thanks for your contribution @lionel- ! |
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.
All the other runner type support in this repo is at the root. Can we set up the just
file so that it also runs from the root, for consistency?
What do you think about putting CONTRIBUTING.md
in its regular location in .github
or also at the root? I wouldn't know to look for it where it currently is.
hmm I think the current location has advantages. The justfile in this location can contain easy shortcuts that are only relevant for vscode dev. If you put it in the root then all vscode-only commands would need to be namespaced, making them less convenient. And there will be a barrier to adding very specialised commands in there as the file is shared with many projects. Similarly the contributing file in the vscode folder is very focused. At the root it could potentially scale to a very large document that is harder to read and less likely to be updated with finer details. Having a contributing file at the root is a good idea but it could be more like an orientation file that links to the subproject dev docs. Likewise, a justfile at the root would contain very general commands pertaining to the monorepo as a whole. |
A chunk of the build scripts that we already have are only relevant for the VS code extension, and I am worried about having things that are so similar in multiple places, from a dev experience perspective. Folks won't have a way to know they are even there; please move them to be together with the other build scripts. If you want to keep this |
8a31dce
to
f990edc
Compare
On the other hand, having a justfile at the top-level is a different matter since, as you mention, we already have a top-level workflow. Are we ready to add a justfile at top-level in addition to our existing The top-level readme now links into our project's contributing file for easier access. |
I just want to register here a preference here for trying hard to reduce tool proliferation. This kind of proliferation adds drag to everyone and is hard to revert. I understand that quarto-dev/quarto is now a place where folks with a large number of backgrounds come to contribute and that makes what I'm asking a tricky proposition. But we really ought to spend energy being intentional about the long-term impact of this kind of thing. I don't feel sufficiently knowledgeable about this entire repo to make this a strong preference. But I want to register here that this sets off some alarms in my head. |
I've now removed the justfile but I just wanted to clarify why we use it in our other projects:
While it is an additional tool in the stack, I the benefits of this tool actually reduce the burden of tool multiplicity. |
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.
Thanks, @lionel- ❤️
This repo is definitely a tricky one from a dev experience perspective since multiple teams work on it, but only part-time.
justfile
and CONTRIBUTING.md
in vscode extensionCONTRIBUTING.md
in vscode extension and top-level install commands
Taking example on Biome, we've started using the just command runner in Ark and Air. I've started one in the vscode extesion to easily install it in Code and Positron and build it in dev/watch mode.
The new contributing file describes our dev workflows.