Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
heaths authored Feb 9, 2024
1 parent b5c7f5f commit 8dd8559
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,16 @@ Contributions are welcome.

Backward compatibility of the user experience (UX) is important. This extension was designed to be fast and simple - built right into users' workflow unlike the original "Insert GUID" that shipped with Visual Studio I sought to improve and replace. So any changes to bindings or menu order should be avoided unless the user has to opt into new behavior through, for example, changing settings to non-default values.

Recommendations from .editorconfig and linting results should be respected, though there are few.
Recommendations from `.editorconfig` and linting results should be respected, though there are few.

Be sure to add an entry to the [CHANGELOG.md](CHANGELOG.md)! For bug fixes, please link to the original issue.

## Prerequisites

* [Node.js 14](https://nodejs.org)
* (Recommended) [VSCode](https://code.visualstudio.com)
* [Node.js 18](https://nodejs.org)
* [Visual Studio Code](https://code.visualstudio.com)

You can also open this repository in a [devcontainer](https://code.visualstudio.com/docs/remote/containers) but on Windows, will need to disable auto-CRLF before cloning the repository:

```cmd
git config --global autocrlf false
```

See [Container Tips](https://code.visualstudio.com/docs/remote/troubleshooting#_container-tips) for more information.

Running in a devcontainer is primarily intended for [GitHub Codespaces](https://code.visualstudio.com/docs/remote/codespaces).
You can also open this repository in a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) in Visual Studio Code or in [GitHub Codespaces](https://code.visualstudio.com/docs/remote/codespaces).

## Building

Expand All @@ -45,8 +37,8 @@ NPM should install everything required to build and test on Windows and macOS. L
npm run test
```

You can run and debug tests in VSCode by running **Launch Tests** in the **Run** (formerly **Debug**) view.
You can run and debug tests in Code by running **Launch Tests** in the **Run** (formerly **Debug**) view.

## Versioning

Versioning is done manually using `npm version` prior to a release by updating the package version in [package.json](package.json). Previously it was done automatically, but often times would skip a significant range of patch versions, which seems odd.
Versioning is done manually using `npm version` prior to a release by updating the package version in `package.json`. Previously it was done automatically, but often times would skip a significant range of patch versions.

0 comments on commit 8dd8559

Please sign in to comment.