detect-secrets/CONTRIBUTING.md

A developer-friendly secrets detection tool for CI and pre-commit hooks based on Yelp's detect-secrets

# Contributing

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to detect-secrets.
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Code of Conduct

This project and everyone participating in it is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

## How to contribute to detect-secrets

<!-- TODO -->

### Tests

Make sure you the code you're adding has decent test coverage.

Running project tests and coverage:

```bash
npm run test
```

### Commit Guidelines

The project uses the commitizen tool for standardizing changelog style commit
messages so you should follow it as so:

```bash
git add .           # add files to staging
npm run commit      # use the wizard for the commit message
```