Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.61 KB
Raw

Contributor Guidelines - How to Contribute to slurp

Reporting a bug you found?

  • 🐛 Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample, or an executable test case demonstrating the expected behavior that is not occurring.

Submitting a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

pre-commit

A framework for managing and maintaining multi-language pre-commit hooks. Pre-commit can be installed with pip, curl, brew or conda. You need to first install pre-commit and then install the pre-commit hooks with pre-commit install.

Now pre-commit will run automatically on git commit! It's usually a good idea to run the hooks against all the files when adding new hooks (usually pre-commit will only run on the changed files during git hooks). Use pre-commit run --all-files to check all files.

General Contributor Guidelines

And always remember, have fun!