|
| 1 | +# MyST Cookbook Contributing Guide Notes |
| 2 | + |
| 3 | +For a more detailed, step-by-step contributor guide, see the **Full Cookbook Contributor's Guide** |
| 4 | +<p style="text-align: center; margin-top: 2em;"> |
| 5 | + <a href="cookbook-guide.md" style="display: inline-block; background-color:rgb(13, 83, 130); color: white; padding: 8px 10px; font-size: 1.1em; border-radius: 8px;"> |
| 6 | + Full Cookbook Contributor's Guide → |
| 7 | + </a> |
| 8 | +</p> |
| 9 | + |
| 10 | + |
| 11 | +--- |
| 12 | +## Create Repository Using Template |
| 13 | + |
| 14 | +1. Navigate to [projectpythia-mystmd/cookbook-template](https://github.com/projectpythia-mystmd/cookbook-template) |
| 15 | +2. Click **"Use This Template"** → **"Create a new repository"** |
| 16 | + |
| 17 | +### On the next page: |
| 18 | +- Check **"Include all branches"** |
| 19 | +- You are the **owner** |
| 20 | +- Create your repository name (should end with `-cookbook`) |
| 21 | +- Select to keep it **Public** |
| 22 | +- Then click **"Create repository"** |
| 23 | + |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## Update Content |
| 28 | + |
| 29 | +Follow [Git/GitHub best practices](https://foundations.projectpythia.org/foundations/getting-started-github.html) with your collaborators: |
| 30 | + |
| 31 | +- Add content with your scientific insight as `.ipynb` files in the `notebooks/` folder |
| 32 | +- Update `environment.yml` to include all necessary packages |
| 33 | +- Update **thumbnail** to visually represent your work |
| 34 | +- Update `README.md` to reflect: |
| 35 | + - Title |
| 36 | + - Description |
| 37 | + - Motivation |
| 38 | + - Authors |
| 39 | + - Content structure |
| 40 | + |
| 41 | +- Update `myst.yml` with: |
| 42 | + - Title |
| 43 | + - GitHub link |
| 44 | + - Tags |
| 45 | + - Keywords (clarify the difference!) |
| 46 | + - Table of contents (`toc`) |
| 47 | + - Jupyter → Binder → Repo links |
| 48 | + |
| 49 | +- Update `CITATION.cff` with: |
| 50 | + - Authors’ names, ORCID, website, and affiliation |
| 51 | + - Title |
| 52 | + - Abstract |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +## Ready to Publish? |
| 57 | + |
| 58 | +1. Make sure you’re added to the `projectpythia-mystmd` organization |
| 59 | +2. From **repository settings**, transfer the repo to the `projectpythia-mystmd` organization |
| 60 | +3. Open a PR editing `cookbook_gallery.txt` with your repo name in the [Cookbook Gallery Repository](https://github.com/projectpythia/cookbook-gallery) |
| 61 | +4. Await review |
| 62 | +5. Someone from the Pythia team will publish a **citable release** |
0 commit comments