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

docs: improve contribution guide #148

Closed
wants to merge 1 commit into from
Closed

docs: improve contribution guide #148

wants to merge 1 commit into from

Conversation

nhedger
Copy link
Member

@nhedger nhedger commented Feb 19, 2024

Summary

Improves the contribution guide

Description

Improves the contribution guide by explaining how the extension can be built locally.

Related Issue

This PR closes #147

@ematipico
Copy link
Member

ematipico commented Feb 19, 2024

Internally there's a command called pack:dev that does bundling, compilation and installation, why can't we document this command instead? (We can rename it) I found that command very easy

@nhedger
Copy link
Member Author

nhedger commented Feb 19, 2024

We can, I just assumed people would just run the app with the debug, as I do.

@ematipico
Copy link
Member

Ok. Sorry if I'm being so dumb, but unfortunately I struggle to understand the flow.

So I open this repository with VSCode, then I click F5, open another project that uses the extension, and when I modify this source the other project will use the new compiled code?

Second thought: the contribution guide assumes that a person uses VSCode, but I use other editors, there's no F5 😅

@nhedger
Copy link
Member Author

nhedger commented Feb 19, 2024

No problem, I'll try to explain this better.

First, the contribution guide assumes that you're using VS Code to develop the extension because it's the easiest way to debug it. We can definitely improve the guide to include instructions for user who don't use VS Code as their main editor, though.

When you open this repo with VS Code and press F5, VS Code will spawn a separate VS Code instance meant only for debugging. This separate instance does two things:

  1. It starts with all extensions disabled
  2. It loads and enables the Biome extension being debugged (the watcher builds it in out/)

You can then use this separate instance to load any other project to test the behavior of the Biome extension on a real project.

Hope this clears it.

@ematipico
Copy link
Member

That's way better, thank you!

@nhedger
Copy link
Member Author

nhedger commented Jul 24, 2024

Will be overhauled as part of v3.

@nhedger nhedger closed this Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 Missing information in the contributing section
2 participants