From a92712adb790b9ba25e38daa0e2cfc6d7e52a0dd Mon Sep 17 00:00:00 2001 From: Ilya Sytchev Date: Mon, 16 Dec 2024 16:41:12 -0500 Subject: [PATCH] Update the dev docs --- docs/source/development.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/development.md b/docs/source/development.md index 8e46b8dc..ce379a77 100644 --- a/docs/source/development.md +++ b/docs/source/development.md @@ -5,9 +5,10 @@ Information for contributors ## Quick start * Change current directory to the top level of your local Forest repository * Install Forest in editable mode along with development tools: `pip install -e ".[dev]"` -* Run code style checks: `flake8` -* Run type hint checks: `mypy` -* Run test suite: `pytest` +* Check code style: `flake8` +* Run static type checks: `mypy` +* Run the test suite: `pytest` +* Validate the citation file: `cffconvert -i CITATION.cff` ### Documentation Install required dependencies: