Skip to content

Commit

Permalink
Better contributing docs (#2162)
Browse files Browse the repository at this point in the history
- Change the reference of build.py to build.sh
- Explain how to run or debug tests locally via VSCode
  • Loading branch information
bdovaz authored Dec 21, 2022
1 parent e13a16d commit 2f7c765
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Each linter must:
- Be defined in a descriptor file. Few properties are required ([see json schema documentation](https://megalinter.github.io/json-schemas/descriptor.html)), but please think to input doc URLs and `ide` section for documentation
- Have two test files in `.automation/test`: one for success and one for failure

Then run `bash build.py` and it will generate all the rest !
Then run `bash build.sh` and it will generate all the rest !

- Documentation (markdown)
- Dockerfile (main and flavors)
Expand All @@ -95,6 +95,11 @@ Then run `bash build.py` and it will generate all the rest !

![Screenshot](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/ContributingAddLinter_1.jpg?raw=true>)

### Execute the tests locally (Visual Studio Code)

1. Install [Test Explorer UI](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer) extension
2. Install [Python Test Explorer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=LittleFoxTeam.vscode-python-test-adapter) extension
3. Execute or debug tests via the side menu

### CI/CT/CD

Expand Down

0 comments on commit 2f7c765

Please sign in to comment.