diff --git a/docs/contributing.md b/docs/contributing.md index d033749f..a65a76a0 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -160,6 +160,7 @@ management commands. - [`gulp docs:watch`](#docswatch) - [`gulp extras`](#extras) - [`gulp fake`](#fake) +- [`gulp format`](#format) - [`gulp generatescheme`](#generatescheme) - [`gulp lint`](#lint) - [`gulp makemessages`](#makemessages) @@ -238,6 +239,11 @@ Adds some fake data to the database. By default, ``fake`` creates one child and default values, e.g. `gulp fake --children 5 --days 7` to generate five fake children and seven days of data for each. +#### `format` + +Formats Baby Buddy's code base using [black](https://github.com/psf/black). Run this +before commits to ensure linting will pass! + #### `generateschema` Updates the [`openapi-schema.yml`](/openapi-schema.yml) file in the project root