Skip to content

Commit

Permalink
docs: update README and developing.md (#5960)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update developing.md
  • Loading branch information
daphne-sfdc authored Nov 25, 2024
1 parent 917f718 commit 217e310
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Dreamforce 2018 session on how to use Visual Studio Code and Salesforce Extensio

If you are interested in contributing, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.

If you are interested in building the extensions locally, please take a look at the publishing [doc](contributing/publishing.md).
If you are interested in building the extensions locally, please take a look at the developing [doc](contributing/developing.md).

You can find more information about developing Salesforce Extensions for VS Code in the [docs](docs) folder. If the docs don’t cover what you are looking for, please feel free to open an issue.
You can find more information about using the Salesforce Extensions for VS Code in the [public documentation](https://developer.salesforce.com/docs/platform/sfvscode-extensions/guide). If the docs don’t cover what you are looking for, please feel free to open an issue.

For information about using the extensions, consult the README.md file for each package.
4 changes: 1 addition & 3 deletions contributing/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

## Pre-requisites

1. We are requiring Node 16 at a minimum. If you need to work with multiple versions of Node, you might consider using [nvm](https://github.com/creationix/nvm).
1. npm v6 is declared as a dependency in the workspace root and gets used by vsce packaging due to [issues with vsce packaging and npm v7/8](https://github.com/forcedotcom/salesforcedx-vscode/pull/4092)
1. npm v8 that comes installed with node 16 would be used when npm is invoked via npm run scripts or manually via shell. Hence the new lock file format of npm v8 with workspaces support is used by `npm install`.
1. We are requiring Node 20 and npm v10 at a minimum. If you need to work with multiple versions of Node, you might consider using [nvm](https://github.com/creationix/nvm).
1. This repository uses [Lerna](https://lerna.js.org) to manage it as a
_monorepo_. Please install Lerna globally using `npm install --global lerna`.
1. We use `eslint` so please install it using `npm install --global eslint`.
Expand Down

0 comments on commit 217e310

Please sign in to comment.