semgrep4techwriting

Experimental repository for Semgrep rules specific to technical writing. High functioning rules may eventually live in an official Semgrep repository. Currently, rules may vary in quality and false positive rate. Use with caution.

Suggested workflow for use

• Add to your CI job.
• Use as a linter.

Suggested workflow for contributing to this repository

• Check if your contribution corresponds to an existing style guide. Top level folders must correspond to style guides such as Microsoft, Google, or IBM.
• If there is no existing top level folder for your style guide, create a top level folder for the style guide that the rule enforces.