Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 4.1 KB
Raw

Contributing

Conduct

All contributors are expected to adhere to the project's Code of Conduct.

Development

To begin development on the VSCode extension for Swift you will need to install Node.js. We use nvm the Node version manager to install Node.js. To install or update nvm you should run their install script

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

More details on nvm installation can be found in the README from its GitHub repository.

Once you have installed nvm, clone this repository, and in the project directory run nvm install. This will install the correct version of node.js for developing the extension. Then you should run npm install to install all the dependencies the extension requires.

When you first open the project in VSCode you will be recommended to also install ESLint, Prettier - Code formatter and esbuild Problem Matchers. Please do so. ESLint, Prettier - Code formatter is used to ensure a consistent style and we expect everyone who contributes to follow this style as well. esbuild Problem Matchers provides proper error output from building the project.

To run your version of the Swift extension while in VSCode, press F5. This will open up another instance of VSCode with it running. You can use the original version of VSCode to debug it.

Submitting a bug or issue

Please ensure to include the following in your bug report:

  • A concise description of the issue, what happened and what you expected.
  • Simple reproduction steps
  • Version of the extension you are using
  • Contextual information (Platform, Swift version etc)

Submitting a Pull Request

Please ensure to include the following in your Pull Request (PR):

  • A description of what you are trying to do. What the PR provides to the library, additional functionality, fixing a bug etc
  • A description of the code changes
  • Documentation on how these changes are being tested
  • Additional tests to show your code working and to ensure future changes don't break your code.

Please keep your PRs to a minimal number of changes. If a PR is large, try to split it up into smaller PRs. Don't move code around unnecessarily as it makes comparing old with new very hard. If you have plans for a large change please talk to the maintainers of the project beforehand. There is a #vscode-swift channel on the Swift Server Slack. You can join here.

Testing

Where possible any new feature should have tests that go along with it, to ensure it works and will continue to work in the future. When a PR is submitted one of the prerequisites for it to be merged is that all tests pass. You can run tests locally using either of the following methods:

  • From VSCode, by selecting "Extension Tests" in the Run and Debug activity.
  • Using npm run test from the command line (when VS Code is not running, or you'll get an error)

sourcekit-lsp

The VSCode extension for Swift relies on Apple's sourcekit-lsp for syntax highlighting, enumerating tests, and more. If you want to test the extension with a different version of the sourcekit-lsp you can add a swift.sourcekit-lsp.serverPath entry in your local settings.json to point to your sourcekit-lsp binary. The setting is no longer visible in the UI because it has been deprecated.

Warning

If your sourcekit-lsp version does not match your toolchain you may experience unexpected behaviour.

Legal

By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license (see LICENSE).