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

minor contributing docs #1866

Merged
merged 6 commits into from
Jan 14, 2025
Merged

minor contributing docs #1866

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f15acc8
minor contributing docs
Sep 7, 2023
e855e88
attempt to use a relative link
saidelike Dec 13, 2023
0a5abaf
Update docs/contributing/CONTRIBUTING.md
AndreasArvidsson Jan 14, 2025
c920084
Update relative link
AndreasArvidsson Jan 14, 2025
d1ede60
Update launch configs
AndreasArvidsson Jan 14, 2025
f66a549
Merge branch 'main' into pr/saidelike/1866
AndreasArvidsson Jan 14, 2025
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: 2 additions & 2 deletions packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A

Also note that if you are adding support for a new language that isn't in the default list of [language identifiers](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) supported by VSCode, you may need to add an extension dependency. See [Adding a new language](./adding-a-new-language.md#2-ensure-file-type-is-supported-by-vscode) for more details.

6. Copy / symlink `cursorless-talon-dev` into your Talon user directory for some useful voice commands for developing Cursorless.
6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.

## Running / testing extension locally

Expand All @@ -65,7 +65,7 @@ If you don't have the `cursorless-talon-dev` files in your Talon user directory

The entire test suite takes a little while to run (1-2 mins), so you may want to run just a subset of the tests.

To specify the set of tests to run, say `"debug generate subset"`, or if you haven't installed the cursorless-talon-dev files, run the VSCode task "Generate test subset file". To do this, choose "Tasks: Run Task" from the command pallete.
To specify the set of tests to run, say `"debug generate subset"`, or if you haven't installed the cursorless-talon-dev files, run the VSCode task "Generate test subset file". To do this, choose "Tasks: Run Task" from the command palette.

To run the specified subset of tests, say `"debug test subset"` (or use the "Run test subset" launch config).

Expand Down
Loading