Skip to content

update contributing guide #539

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 26, 2025
Merged

update contributing guide #539

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2189080
update contributing guide
jukent Jun 25, 2025
a95b4b1
active language
jukent Jun 26, 2025
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
12 changes: 4 additions & 8 deletions appendix/how-to-contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,23 +48,19 @@ To build the book locally, run the following:

```bash
conda activate pythia-book-dev
jupyter-book build .
myst start --execute
```

Finally, you can view the book by opening the file `_build/html/index.html` with your favorite web browser. On most platforms you can simply run:

```bash
open _build/html/index.html
```
Finally, you can view the book by opening the localhost link that should be generated in your terminal.

### Keeping your dev environment up to date

It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `jupyter-book build .` command above generates error messages, that is a good indication that your conda environment may be out of date.
It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `myst start --execute` command above generates error messages, that is a good indication that your conda environment may be out of date.

To update all packages in the currently activated environment to their latest versions, do this:

```bash
conda update --all
```

[pythia contributor's guide]: https://projectpythia.org/contributing.html
[pythia contributor's guide]: https://projectpythia.org/pythia-contributing.html