Skip to content

Commit

Permalink
Merge pull request #3 from JuliaComputing/sjkelly-patch-1
Browse files Browse the repository at this point in the history
Make it clear that a path is argument to `-c`
  • Loading branch information
sjkelly authored Jul 20, 2023
2 parents 6dd2ae0 + 725dcb1 commit 630c2db
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ There rules are likely to have some false positives and negatives, so feedback w

* [Install the Semgrep CLI](https://semgrep.dev/docs/getting-started/)
* Clone this repo `git clone https://github.com/JuliaComputing/semgrep-rules-julia.git`
* Run `semgrep -c semgrep-rules-julia /path/to/your/package`
* Run `semgrep -c /path/to/semgrep-rules-julia/ /path/to/your/package`
* Semgrep has good [documentation](https://semgrep.dev/docs/) and [tutorials](https://semgrep.dev/learn/), which have more information about the tool.
* [Semgrep Playground](https://semgrep.dev/playground/) is the best way to experiment with new rules.


## Contribute

We welcome, and appreciate, new analysis rules. Please open a PR to this repo to add your rule to the ruleset. Rules here should be generally be widely, though not necessarily always, applicable. For each rule in its own `.yaml` file, there should be a corresponding `.jl` file with testcases.
We welcome, and appreciate, new analysis rules. Please open a PR to this repo to add your rule to the ruleset. Rules here should be generally be widely, though not necessarily always, applicable. For each rule in its own `.yaml` file, there should be a corresponding `.jl` file with testcases.

0 comments on commit 630c2db

Please sign in to comment.