Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributor documentation for important components of a PR #1151

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,14 @@ 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.

### Modifying Jupyter notebook
#### 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`.
Change the cell you want and then, execute it so the expected output is shown.
Expand All @@ -65,7 +72,6 @@ testing.
In case that the in[number] of cells aren't in order you should go to the
kernel in the toolbar and restart it.


#### Releasing a version

```
Expand Down