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

Updated contributing guide to include the debugging workflow. #177

Merged
merged 3 commits into from
Aug 7, 2024

Conversation

soerendomroes
Copy link
Collaborator

@soerendomroes soerendomroes commented Aug 5, 2024

I added a recommended npm version. If you are using a different one, please correct me.

Instead of only an install command, I updated the guide and split the install command install and installExtension.

I updated the debugging guide for the VS Code + IntelliJ combination on the VS Code side.

Note that splitting the install command might be annoying for several users that previously used it to install the extension, maybe the npm install && npm run installExtension command should be also put in the readme?

Maybe we should also add why Rust is necessary to build this.

@soerendomroes soerendomroes added the documentation Improvements or additions to documentation label Aug 5, 2024
package.json Outdated Show resolved Hide resolved
Co-authored-by: Marten Lohstroh <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍

@lhstrh lhstrh merged commit 665bc9d into main Aug 7, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants