Skip to content

Commit e9e3e74

Browse files
authored
update contributing guide (#539)
* update contributing guide * active language
1 parent 17e9529 commit e9e3e74

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

appendix/how-to-contribute.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
# Pythia Foundations Contributor's Guide
2-
3-
```{note}
4-
This content is under construction!
5-
```
1+
# Contributing to Foundations
62

73
General information on how to contribute to any Project Pythia repository
8-
may be found [here][pythia contributor's guide].
4+
may be found in the [Contributing to Project Pythia](https://projectpythia.org/contributing) guide.
95

10-
This page will eventually contain a full guide to contributing to Project Pythia. As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests.
6+
As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests.
117

12-
If you need to comment on anything in Pythia Foundations you feel needs work, you can use the "open issue" or "suggest edit" buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This contributor's guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main [Project Pythia Contributor's Guide][pythia contributor's guide].
8+
If you need to comment on anything in Pythia Foundations you feel needs work, you can use the "open issue" or "suggest edit" buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main guide for [Contributing to Project Pythia](https://projectpythia.org/contributing).
139

1410
To quickly provide feedback about minor issues without the use of GitHub, you can also use this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSeVa1TC9xM-dk7qIE2e8bsgSrIP82yYDNw3wew3J46eREJa4w/viewform?usp=sf_link).
1511

@@ -48,23 +44,19 @@ To build the book locally, run the following:
4844

4945
```bash
5046
conda activate pythia-book-dev
51-
jupyter-book build .
47+
myst start --execute
5248
```
5349

54-
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:
55-
56-
```bash
57-
open _build/html/index.html
58-
```
50+
Finally, you can view the book by opening the localhost link that should be generated in your terminal.
5951

6052
### Keeping your dev environment up to date
6153

62-
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.
54+
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.
6355

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

6658
```bash
6759
conda update --all
6860
```
6961

70-
[pythia contributor's guide]: https://projectpythia.org/contributing.html
62+
[Contributing to Project Pythia]: https://projectpythia.org/contributing.html

0 commit comments

Comments
 (0)