From 69bc7b02e29eeaaa2243257311f2f7853836662f Mon Sep 17 00:00:00 2001 From: Olivier Delalleau <507137+odelalleau@users.noreply.github.com> Date: Tue, 16 Jan 2024 12:23:27 -0500 Subject: [PATCH] Add contributor documentation for important components of a PR --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 724a75e06..9aa9d1c0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,6 +55,13 @@ Imports are sorted using isort, use `isort .` to sort all imports prior to pushi To build the docs execute `nox -s docs` or `make`(inside docs folder). Make gives you different options, for example, you can build the docs as html files with `make html`. Once the docs are built you can open `index.html` in the build directory to view the generated docs with your browser. +#### Submitting a PR + +When submitting a PR please ensure that it includes: +- automated tests for any new feature or bugfix +- documentation for any user-facing change +- a one-line news fragment under the `news` folder (valid extensions are: `.feature`, `.bugfix`, `.api_change`, `.docs`, `.misc`) + #### Modifying the Jupyter notebook In order to change the Jupyter notebook you first need to open it with `jupyter notebook`.