docs: add vscode note to CONTRIBUTING.md #641
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a reference to VScode and the Hardhat extension in the contribution guidelines.
victorges
approved these changes
Apr 23, 2024
|
|
||
| ## Development Environment | ||
|
|
||
| For easy development, we recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Hardhat extension](https://hardhat.org/hardhat-vscode/docs/overview). This will provide you with syntax highlighting, code completion, debugging capabilities, and an easy-to-use test explorer. |
There was a problem hiding this comment.
Just a note that I've had mixed experiences with the VSCode Solidity extensions.
IIRC the official Solidity extension worked well for most things but navigating through the code ("go to implementation" kind of thing) and the Hardhat one fixed that but broke other things. Maybe it's because we previously didn't have a remappings.txt file, not sure.
If you are getting a clean dev xp with that setup, let's update this doc with it though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this pull request do? Explain your changes. (required)
This commit adds a reference to VScode and the Hardhat extension in the
contribution guidelines. Feel free to close if this is not the recommended way of working with the codebase.
Specific updates (required)
How did you test each of these updates (required)
Not needed.
Does this pull request close any open issues?
No
Checklist:
yarn testpass