From a5bfe337dca25d9a5de6ddf0e8257fa0e0035db1 Mon Sep 17 00:00:00 2001 From: nyanpasu64 Date: Thu, 3 Jan 2019 18:36:23 -0800 Subject: [PATCH] Add Black instructions to README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4d97e80..045770a 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,16 @@ python -m corrscope (args) 1. Render and encode MP4 video (requires ffmpeg) - `corrscope master.yaml -r/--render` + +## Contributing + +Issues, feature requests, and pull requests are accepted. + +This project uses [Black code formatting](https://github.com/ambv/black). Either pull request authors can reformat code before creating a PR, or maintainers can reformat code before merging. + +You can install a Git pre-commit hook to apply Black formatting before each commit. Open a terminal/cmd in this repository and run: + +```sh +pip install --user pre-commit +pre-commit install +```