X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c4a477bc693bebcdd176ed23608532df13373c36..65f0ea61599dc6d2be95ee961c42a55247130c49:/docs/version_control_integration.md diff --git a/docs/version_control_integration.md b/docs/version_control_integration.md deleted file mode 120000 index 8de4b67..0000000 --- a/docs/version_control_integration.md +++ /dev/null @@ -1 +0,0 @@ -_build/generated/version_control_integration.md \ No newline at end of file diff --git a/docs/version_control_integration.md b/docs/version_control_integration.md new file mode 100644 index 0000000..2d8bc17 --- /dev/null +++ b/docs/version_control_integration.md @@ -0,0 +1,28 @@ +[//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM README.md" + +# Version control integration + +Use [pre-commit](https://pre-commit.com/). Once you +[have it installed](https://pre-commit.com/#install), add this to the +`.pre-commit-config.yaml` in your repository: + +```yaml +repos: + - repo: https://github.com/psf/black + rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags + hooks: + - id: black + language_version: python3 # Should be a command that runs python3.6+ +``` + +Then run `pre-commit install` and you're ready to go. + +Avoid using `args` in the hook. Instead, store necessary configuration in +`pyproject.toml` so that editors and command-line usage of Black all behave consistently +for your project. See _Black_'s own +[pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an +example. + +If you're already using Python 3.7, switch the `language_version` accordingly. Finally, +`stable` is a branch that tracks the latest release on PyPI. If you'd rather run on +master, this is also an option.