We welcome contributions to this repo! Please fork and make a pull request.
We're happy to help [email protected] or join the Semgrep community slack.
Before each commit,
git should run pre-commit
to ensure files are well-formatted
and check for basic linting bugs.
If you don't have pre-commit installed,
the following command will do so for you:
$ python -m pip install pre-commit
Our pre-commit configuration uses Docker images.
Please ensure you have Docker installed
before running pre-commit.
Install the pre-commit hooks with the following command:
$ pre-commit install
To check if pre-commit is working as expected,
run the following command:
$ pre-commit run --all
Once pre-commit is set up
you may commit code and create pull requests as you would expect.
Pull requests require approval of at least one maintainer
and CI to be passing.