From 8da700a979d55b316ee36663adcce8ef20e20659 Mon Sep 17 00:00:00 2001 From: Jae-Won Chung Date: Thu, 19 Sep 2024 11:28:10 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87c7c297..d9845366 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,7 @@ Zeus is guided by the **Benevolent Dictator For Life (BDFL)** model, where the p 1. **Dev dependencies**: `pip install -e '.[dev]'` will be helpful. 1. **Code and Test**: Write code and make sure to add tests. `pytest` should successfully terminate including the new tests you wrote. 1. **Format and Lint**: Run `bash scripts/lint.sh` and make sure it runs without complaining. +1. **Check documentation**: Run `bash scripts/preview_docs.sh` to build and spin up a local instance of the documentation. In particular, check whether your docstrings are correctly rendered in the Source Code Reference section. 1. **Pull Request**: Open a PR to the main repository. Ensure all CI checks pass before requesting a review. ## Coding Standards