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.

Sign up for GitHub

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

Jump to bottom

docs: add vscode note to CONTRIBUTING.md #641

Open
wants to merge 1 commit into
base: delta
Choose a base branch
from
Open

docs: add vscode note to CONTRIBUTING.md #641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ specifier is not provided.
Prefer `external` to `public` if you know a function will only be called externally. If there is a possibility
of a function being called internally as well as externally, the function should be `public`. `external` functions can be more
efficient when a function parameter is a large array of data.

## 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.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Loading