|
1 | | -# semgrep-rules |
2 | | - |
3 | | -[](https://semgrep.dev/) |
4 | | -<a href="https://go.semgrep.dev/slack"> |
5 | | -<img src="https://img.shields.io/badge/community%20slack-3.5k%20members-green?style=flat-square" alt="Join Semgrep community Slack" /> |
6 | | -</a> |
7 | | - |
8 | | -Welcome! This repository is the standard library for open source [Semgrep](https://semgrep.dev/) rules. |
9 | | - |
10 | | -In addition to the rules in this repository, the [Semgrep Registry](https://semgrep.dev/explore) offers proprietary [Pro rules](https://semgrep.dev/products/semgrep-code/pro-rules) that enable interfile and interprocedural analysis. |
11 | | - |
12 | | -- Find rules: search for open source and Pro rules through the [Semgrep registry search](https://semgrep.dev/r). |
13 | | -- Use rules: Scan your code with these rules through [Semgrep AppSec Platform](https://semgrep.dev/login) |
14 | | -- Contribute to rules: see [Contributing to Semgrep rules](https://semgrep.dev/docs/contributing/contributing-to-semgrep-rules-repository/) for more information. |
15 | | - |
16 | | -## Using the Semgrep rules repository |
17 | | - |
18 | | -To start writing and using Semgrep rules, see [Learn Semgrep syntax](https://semgrep.dev/learn) and [Writing rules](https://semgrep.dev/docs/writing-rules/overview/). Then, run existing and custom Semgrep rules locally with the [Semgrep command line interface (Semgrep CLI)](https://semgrep.dev/docs/getting-started/) or [continuously with Semgrep in CI while using Semgrep AppSec Platform](https://semgrep.dev/docs/semgrep-app/getting-started-with-semgrep-app/). |
19 | | - |
20 | | -## Writing Semgrep rules |
21 | | - |
22 | | -See [Writing rules](https://semgrep.dev/docs/writing-rules/overview/) for information including: |
23 | | - |
24 | | -- Pattern syntax, describing what Semgrep patterns can do in detail, and example use cases of the ellipsis operator, metavariables. |
25 | | -- Rule syntax, describing Semgrep YAML rule files, which can have multiple patterns, detailed output messages, and autofixes. The syntax allows the composition of individual patterns with boolean operators. |
26 | | - |
27 | | -You can also learn how to write rules using the [interactive, example-based Semgrep rule tutorial](https://semgrep.dev/learn). |
28 | | - |
29 | | -## Contributing |
30 | | - |
31 | | -We welcome Semgrep rule contributions directly to this repository! When submitting your contribution to this repository, we’ll ask you to make Semgrep, Inc. a joint owner of your contributions. While you still own copyright rights to your rule, joint ownership allows Semgrep, Inc. to license these contributions to other [Semgrep Registry](https://semgrep.dev/r) users pursuant to the LGPL 2.1 under the [Commons Clause](https://commonsclause.com/). See full [license details](https://github.com/opengrep/opengrep-rules/blob/develop/LICENSE). |
32 | | - |
33 | | -Note: To contribute, review the **[Contributing to Semgrep rules](https://semgrep.dev/docs/contributing/contributing-to-semgrep-rules-repository/)** documentation. |
34 | | - |
35 | | -You can also contact us at [email protected] to make Semgrep rule contributions. We will import your rules for everyone to use! |
36 | | - |
37 | | -## Additional information |
38 | | - |
39 | | -### Help |
40 | | - |
41 | | -Join [Slack ](https://go.semgrep.dev/slack) for the fastest answers to your questions! Or contact the team at [email protected]. |
42 | | - |
43 | | -### GitHub action to run tests |
44 | | - |
45 | | -If you fork this repository or create your own, you can add a GitHub Action to your workflow that will automatically test your rules using the latest version of Semgrep. See our [semgrep-rules-test example](https://github.com/opengrep/opengrep-rules/blob/develop/.github/workflows/semgrep-rules-test.yml). |
46 | | - |
47 | | -### Rulesets |
48 | | - |
49 | | -Rulesets are groups of rules organized by purpose, language, or framework sourced from the Semgrep Registry. If you want to modify existing rulesets or create your own, please contact us at [email protected]. |
| 1 | +### Welcome to Opengrep Rules, a fork of Semgrep Rules, under the LGPL 2.1 license |
| 2 | +This project is a fork of Semgrep, created by Semgrep Inc. Opengrep is not affiliated with or endorsed by Semgrep Inc. |
| 3 | +*** |
0 commit comments