-
Notifications
You must be signed in to change notification settings - Fork 450
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d970398
commit 72ded8e
Showing
2 changed files
with
33 additions
and
38 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# How to Contribute to CMake Tools | ||
|
||
This article is for developers who want to contribute to the CMake Tools open source project. | ||
|
||
## Build the CMake Tools extension | ||
|
||
As with most VS Code extensions, you'll need [Node.JS](https://nodejs.org/en/) installed. We use [yarn](https://yarnpkg.com/getting-started/install) to compile the code. | ||
|
||
The process is: | ||
|
||
1. Open the repo in VS Code | ||
|
||
2. Press <kbd>F5</kbd> to build and run the extension | ||
|
||
## Coding guidelines | ||
|
||
### Formatting | ||
|
||
Code is formatted using `clang-format`. We recommend you install the | ||
[Clang-Format extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format). | ||
|
||
### Linting | ||
|
||
We use eslint for linting our sources. | ||
You can run `eslint` across the sources from a terminal or command prompt by running `yarn run lint`. | ||
Warnings from `eslint` show up in the **Errors and Warnings** pane and you can navigate to them from inside VS Code. | ||
To lint the source as you make changes, install the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint). | ||
|
||
### Style [Updated!] | ||
|
||
Follow the [Typescript Coding guidelines](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines). | ||
|
||
> `snake_case` was used historically for variables in this repo, but that style is phased out. All new variables should be `lowerCamelCase`. |
This file was deleted.
Oops, something went wrong.