Skip to content

Commit d34425d

Browse files
authored
Clarify that contributing through the platform is for new rules (#2011)
1 parent b690345 commit d34425d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/contributing/contributing-rules.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ Publish rules to the Semgrep Registry to share them with the Semgrep community a
1515

1616
<dl>
1717
<dt>For users of Semgrep AppSec Platform</dt>
18-
<dd>Contribute rules to the Semgrep Registry through Semgrep AppSec Platform. This workflow is recommended. See <a href="#contribute-through-semgrep-appsec-platform-recommended"> Contribute through Semgrep AppSec Platform (recommended)</a>. This workflow creates the necessary pull request for you and streamlines the whole process.</dd>
18+
<dd>Contribute new rules to the Semgrep Registry through Semgrep AppSec Platform. This workflow is recommended. See <a href="#contribute-through-semgrep-appsec-platform-recommended"> Contribute through Semgrep AppSec Platform (recommended)</a>. This workflow creates the necessary pull request for you and streamlines the whole process.</dd>
1919
<dt>For contributors to the repository through GitHub</dt>
20-
<dd>Contribute rules to the Semgrep Registry through a pull request to `semgrep-rules`. See the <a href="#contribute-through-github"> Contribute through GitHub</a> section for detailed information.</dd>
20+
<dd>Contribute rules to the Semgrep Registry, or suggest changes to existing rules, through a pull request to `semgrep-rules`. See the <a href="#contribute-through-github"> Contribute through GitHub</a> section for detailed information.</dd>
2121
</dl>
2222

2323
## Contribute through Semgrep AppSec Platform (recommended)
2424

25+
This is the recommended path for adding a new rule. To suggest a change to an existing rule, see [Update existing rules in Semgrep Registry](#update-existing-rules-in-semgrep-registry).
26+
2527
1. Sign in to [<i class="fas fa-external-link fa-xs"></i> Semgrep AppSec Platform](https://semgrep.dev/login).
2628
1. Go to the [<i class="fas fa-external-link fa-xs"></i> Semgrep Playground](https://semgrep.dev/playground/new).
2729
1. Click <i className="fa-solid fa-file-plus-minus inline_svg"></i> **Create New Rule**.

0 commit comments

Comments
 (0)