You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ _Provide description of this PR and changes, if linked Jira ticket doesn't cover
4
4
5
5
### Checklist
6
6
7
+
-[ ] Read and understood the [Code of Conduct](https://github.com/snyk/vscode-extension/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/snyk/vscode-extension/blob/main/CONTRIBUTING.md).
# Add each resource as a key, value pair, mapping the local resource to the reference file (which should be stored in the language server repository). For example:
always be concise, direct and don't try to appease me.
3
+
DOUBLE CHECK THAT YOUR CHANGES ARE REALLY NEEDED. ALWAYS STICK TO THE GIVEN GOAL, NOT MORE.
4
+
I repeat: don't optimize, don't refactor if not needed.
5
+
Adhere to the rules, fix linting & test issues that are newly introduced.
6
+
don't change old entries in the changelog. it's a history of changes. the current version is the last semantic version tag on origin/main in git
7
+
8
+
** how to implement **
9
+
always write and update test cases. iterate until they pass.
10
+
npm build scripts are configured for both unit and integration tests in package.json (test:unit and test:integration).
11
+
use existing mocks, don't write new ones.
12
+
if you use mocks, use mockk to generate them.
13
+
always run the tests after editing.
14
+
always use the linter, use npm lint:fix. only fix linting issues in changed files.
15
+
don't change code that does not need to be changed. only do the minimum changes.
16
+
add a summary of the changes to the changelog for the next version. usually it's a minor semantic version bump.
17
+
this is not a library. if files are not used or needed anymore, delete them instead of deprecating them.
18
+
if a tool call fails, analyze why it failed and correct your approach. don't prompt the user for help.
19
+
if you don't know something, read the code instead of assuming it.
20
+
commenting out code to fix errors is not a solution. instead, fix the error.
21
+
22
+
** security **
23
+
determine the absolute path of the project directory. you can do that e.g. by executing pwd on the shell within the directory.
24
+
always use snyk for sca and code scanning. scan with both tools. you need to pass the absolute path of the directory we are scanning.
25
+
run snyk code tests after each edit. pass the absolute path of the project directory as a parameter
26
+
run snyk sca tests after updating package.json and pass the absolute path of the project directory as a parameter.
27
+
run snyk sca and code test before committing. if not test data, fix issues before committing.
28
+
29
+
** fixing issues **
30
+
fix security issues if they are fixable. take the snyk scan results and the test results as input.
31
+
32
+
** committing **
33
+
when asked to commit, always use conventional commit messages (Conventional Commit Style (Subject + Body)). be descriptive in the body. if you find a JIRA issue (IDE-XXXX) in the branch name, use it as a postfix to the subject line in the format [IDE-XXXX]
34
+
consider all commits in the current branch when committing, to have the context of the current changes.
35
+
when asked to push, always use 'git push --set-upstream origin $(git_current_branch)' with git_current_branch being the current branch we are on
36
+
never force push
37
+
never push without asking
38
+
never commit the hashicorp gomod
39
+
regularly fetch main branch and offer to merge it into git_current_branch
40
+
don't touch the copyright header
41
+
after pushing offer to create a PR on github. analyze the changes by comparing the current branch ($(git_current_branch)) with origin/main, and craft a PR description and title.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+40Lines changed: 40 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,43 @@
1
+
# Contributing to the Snyk IDE Extensions
2
+
3
+
We welcome contributions, but please read first! To ensure a smooth process and that your valuable work aligns with our roadmap, please keep the following in mind to help manage expectations:
4
+
5
+
## 1. Planning your changes
6
+
7
+
Before undertaking any changes or new features, please discuss your plans with us. This helps align on scope, design, technical approach, and priority.
8
+
Even bug fixes can have unforeseen impacts or alternative solutions better suited for the codebase, so please ask first, we will be happy to discuss.
9
+
Please raise a request with [support](https://support.snyk.io). (Snyk employees, use `#ask-ide`)
10
+
11
+
## 2. Where changes should be made
12
+
13
+
Consider whether your proposed change should be implemented within the IDE extension(s) or in the shared Language Server and related stack.
14
+
-[Snyk Language Server](https://github.com/snyk/snyk-ls)
If your change is applicable to other Snyk IDE plugins as well, we may expect you to submit similar PRs for the other relevant IDE repositories after your initial PR has been reviewed and approved, as they will _usually_ need to be merged all at once or not at all.
-[Snyk Visual Studio extension](https://github.com/snyk/snyk-visual-studio-plugin)
24
+
25
+
## 4. Manual testing
26
+
27
+
All changes must be thoroughly manually tested by you.
28
+
For visual changes the PR template asks for screenshots, so this is a good opportunity to snap them.
29
+
30
+
## 5. Documentation changes
31
+
32
+
Any user-facing changes will require [documentation](https://docs.snyk.io/) changes, which you will need to prepare.
33
+
If you do not have access to our content management system (you are not a Snyk employee), please add the documentation changes required (including new wording and screenshots) to the PR description.
34
+
35
+
We can instruct you on what to add to the CHANGELOG.md, so please ask.
36
+
37
+
---
38
+
39
+
# Making Changes
40
+
1
41
## Run extension and debug
2
42
3
43
Clone the repository, then run `npm install && npm run build` in the directory.
Copy file name to clipboardExpand all lines: Contributor-Agreement.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ This Contributor Licence Agreement (“Agreement”) sets out the terms under wh
2
2
3
3
Who the “Contributor” is depends on whether the person submitting the contribution is a private individual acting on their own behalf, or is acting on behalf of someone else (for example, their employer). The “Contributor” in this Agreement is therefore either: (i) if the individual who Submits a Contribution does so on behalf of their employer or another Legal Entity, any Legal Entity on behalf of whom a Contribution has been received by Snyk; or in all other cases (ii) the individual who Submits a Contribution to Snyk. "Legal Entity" means an entity which is not a natural person (for example, a limited company or corporation).
4
4
5
-
**1. Interpretation**
5
+
**1. Interpretation**
6
6
7
7
The following definitions and rules of interpretation apply in this Agreement.
Copy file name to clipboardExpand all lines: README.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ Integrating security checks early in your development lifecycle helps you pass s
6
6
7
7
The Snyk Visual Studio Code extension allows you to analyze your code, open-source dependencies, and Infrastructure as Code (IaC) configurations. With actionable insights directly in your IDE, you can address issues as they arise.
8
8
9
+
10
+
The extension also works for other VSCode-based IDEs such as Windsurf, Cursor, and Eclipse Theia.
11
+
12
+
9
13
**Key features:**
10
14
11
15
***In-line issue highlighting:** Security issues are flagged directly within your code, categorized by type and severity for quick identification and resolution.
@@ -17,6 +21,12 @@ The Snyk Visual Studio Code extension allows you to analyze your code, open-sour
17
21
18
22
## How to install and set up the extension
19
23
24
+
25
+
For information about the versions of Visual Studio Code supported by the Visual Studio Code extension, see [Snyk IDE plugins and extensions](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions).
26
+
27
+
Snyk recommends always using the latest version of the Visual Studio Code extension.
28
+
29
+
20
30
You can use the Snyk Visual Studio Code extension in the following environments:
21
31
22
32
* Linux: AMD64 and ARM64
@@ -25,24 +35,25 @@ You can use the Snyk Visual Studio Code extension in the following environments:
25
35
26
36
Snyk Visual Studio Code extension does not support remote and containerized environments:
27
37
28
-
*[Cloud VS Code IDE](https://code.visualstudio.com/docs/editor/vscode-web)
38
+
*[Visual Studio Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web)
*[Inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
40
+
*[Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
31
41
32
-
Install the plugin at any time free of charge from the [Visual Studio Code marketplace](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner) and use it with any Snyk account, including a Free account. For more information, see the[VS Code extension installation guide](https://code.visualstudio.com/docs/editor/extension-marketplace#\_install-an-extension).
42
+
Install the plugin at any time free of charge from the [Visual Studio Code marketplace](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner) and use it with any Snyk account, including a Free account. For more information, see the[VS Code extension installation guide](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-an-extension).
33
43
34
44
When the extension is installed, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server).
35
45
36
46
Continue by following the instructions in the other Visual Studio Code extension docs:
37
47
38
-
*[Visual Studio Code extension configuration](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/visual-studio-code-extension-authentication)
39
-
*[Visual Studio Code extension authentication](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/visual-studio-code-extension-authentication)
48
+
*[Visual Studio Code extension configuration, environment variables, and proxy](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/visual-studio-code-extension-configuration-environment-variables-and-proxy)
49
+
*[Authentication for Visual Studio Code extension](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/visual-studio-code-extension-authentication)
40
50
*[Visual Studio Code Workspace trust](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/workspace-trust)
51
+
*[Create a .dcignore file](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/create-a-.dcignore-file)
41
52
*[Run an analysis with Visual Studio Code extension](https://docs.snyk.io/integrate-with-snyk/use-snyk-in-your-ide/visual-studio-code-extension/run-an-analysis-with-visual-studio-code-extension)
42
53
*[View analysis results from Visual Studio Code extension](https://docs.snyk.io/integrate-with-snyk/use-snyk-in-your-ide/visual-studio-code-extension/view-analysis-results-from-visual-studio-code-extension)
43
54
44
55
## Support
45
56
46
57
For troubleshooting and known issues, see [Troubleshooting for Visual Studio Code extension](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/visual-studio-code-extension/troubleshooting-for-visual-studio-code-extension).
47
58
48
-
If you need help, submit a request to [Snyk Support](https://support.snyk.io/hc/en-us/requests/new).
59
+
If you need help, submit a request to [Snyk Support](https://support.snyk.io).
0 commit comments