Skip to content

Some small typo corrections in README #32

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

Open
ericwb wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Some small typo corrections in README #32

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a07e91
Some small typo corrections in README
ericwb Mar 19, 2024
6157ca1
Update README.md
ericwb Mar 19, 2024
5682ad6
Update README.md
ericwb Mar 19, 2024
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Hub of all open-source third-party static analyzers supported by DeepSource. Usa
To add a new analyzer, create a new directory with the analyzer shortcode under the `analyzers` folder.
The following are very important to sync analyzers with DeepSource:

1. `.deepsource/analyzer` directory under `analyzer/<analyzer-shortcode>` directory.
1. `.deepsource/analyzer` directory under `analyzers/<analyzer-shortcode>` directory.

a. It should contain an `analyzer.toml` file with the following fields:

Expand All @@ -32,11 +32,11 @@ The following are very important to sync analyzers with DeepSource:
- `tool_latest_version`: Analyzer's latest version for which issues are synced on DeepSource.
- `description`: A readable descrioption for this analyzer.

b. It should contain am `example.toml` file with a snippet to activate this analyzer in `.deepsource.toml` config.
b. It should contain an `example_config.toml` file with a snippet to activate this analyzer in `.deepsource.toml` config.

c. `logo.svg` file.

2. `.deepsource/issues` directory. This contains all issues detected by the analyzer. Each issue's filemane should be `<issue-shortcode>.toml` or `<issue-shortcode.md>` with the following fields:
2. `.deepsource/issues` directory. This contains all issues detected by the analyzer. Each issue's filename should be `<issue-shortcode>.toml` or `<issue-shortcode.md>` with the following fields:

- `title`: Title of the issue. No periods are allowed in the title.
- `category`: Category of the issue. Allowed values are: "bug-risk", "doc", "style", "antipattern", "coverage", "security", "performance", "typecheck", and, "secrets".
Expand All @@ -51,7 +51,7 @@ Each file should be names as `<provider>.<extention>`. Example: `github.yml`, `c

4. `utils` directory:

It should contain all the utilities required for the analyzer like issue genrator, issue-map, etc.
It should contain all the utilities required for the analyzer like issue generator, issue-map, etc.
For example, please check out `analyzers/kube-linter/utils`.

5. Add a sample sarif report from the analyzer in `tests/fixtures` directory. The file should be named as `<analyzer-shortcode>.sarif`.
Expand Down