Skip to content

update contributing guides #536

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

Merged
merged 4 commits into from
Jun 26, 2025
Merged

update contributing guides #536

merged 4 commits into from
Jun 26, 2025

Conversation

jukent
Copy link
Contributor

@jukent jukent commented Jun 25, 2025

Updates project-wide contribution (changed name to reduce a frequent confusion I have), updates repo specific contribution guide, updates Cookbook guide to match MyST workflow and for clarity, and adds a lightweight Cookbook guide.

@jukent jukent requested review from a team as code owners June 25, 2025 21:47
@jukent jukent requested review from dopplershift, clyne and mgrover1 and removed request for a team June 25, 2025 21:47
Copy link
Contributor

github-actions bot commented Jun 25, 2025

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: fe59bbd
✅ Deployment Preview URL: https://projectpythia.github.io/_preview/536

@r-ford
Copy link
Member

r-ford commented Jun 25, 2025

Related: #428, #431, #447, #518, #534

@jukent
Copy link
Contributor Author

jukent commented Jun 25, 2025

Related: #428, #431, #447, #518, #534

Thanks for reminding me of these issues @r-ford I'm off for the day but will look at making everything consistent tomorrow.

@brian-rose
Copy link
Member

I have some reservations about renaming several of these files because that will likely break existing links. Since we're not running full link checking right now, we may not spot all broken internal links, and may also inadvertently break external links to our content. So I think there needs to be a cost-benefit consideration.

@jukent
Copy link
Contributor Author

jukent commented Jun 26, 2025

Heard @brian-rose I changed the file name back.

I updated the language and a few other things.

Any insight why it looks like I'm adding a myst.yml file? I don't remember us removing one or why we wouldn't have needed it.

Copy link
Member

@erogluorhan erogluorhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me; thanks for this!

@jukent jukent merged commit bcc2bb2 into ProjectPythia:main Jun 26, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 26, 2025
@erogluorhan
Copy link
Member

Any insight why it looks like I'm adding a myst.yml file? I don't remember us removing one or why we wouldn't have needed it.

Actually, from the history, myst.yml seems to have been moved into /portal with PR#519.

With this PR got merged, we have a duplicate file now in the root as well.

@brian-rose
Copy link
Member

#519 was necessary to restore the correct URLs for pages on the portal site. Also keeping myst.yml inside the /portal directory and running the myst build from there keeps the build process consistent with our previous portal, which means fewer edits to contributors guides etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants