Contributors guide

[clyne]

This PR partially (mostly) addresses #19. It provides a general, but detailed, guide to contributing to Project Pythia, and provides links to repo-specific contributors information (i.e. how to contribute to Foundations). The general guide covers the different ways to contribute (including how to submit an external link); setting up git, github, and conda; and how to use the "forking workflow"

N.B. changes to the foundations contributor's guide are forthcoming

[clyne]

@andersy005, any guidance on how to trouble shoot these lint errors? Can I run the linter locally...Thanks!

[andersy005]

@andersy005, any guidance on how to trouble shoot these lint errors? Can I run the linter locally...Thanks!

@clyne, Try the following

• Add pre-commit to the list of dependencies in ci/environment.yml and run conda env update -f ci/environment.yml
• Install pre-commit with conda activate pythia && pre-commit install
• Run pre-commit run --all-files to fix files from previous commits
• The pre-commit hooks should run automatically for any subsequent commits.

[clyne]

Thanks @andersy005 ! That worked. Is there a reason we don't have this baked in to our build environment? We seem to for the foundations portal...

[andersy005]

Thanks @andersy005 ! That worked. Is there a reason we don't have this baked in to our build environment? We seem to for the foundations portal...

You are welcome! I think we just forgot to include it in our local build environment

[clyne]

How about we add it, and I'll update the contributor's guide while I'm working on it?

[andersy005]

How about we add it, and I'll update the contributor's guide while I'm working on it?

👍🏽 Sounds good

[kmpaul]

Looks good. Thanks, @clyne!

[clyne]

Just need some of you folks who gave thumbs up, looks good, etc. to actually approve :-). Tagging @andersy005 @kmpaul @jukent

Nag, nag, nag..

[brian-rose]

Looks like this needs approval specifically from @kmpaul and/or @ktyle as code owners.

[brian-rose]

Ok the merge button is still red even with 3 explicit approvals, because of our relic code-owners setup that will be fixed with #105.

Either @kmpaul can approve and merge this, or if he's busy elsewhere I'll just force-merge later today.

[clyne]

This PR seems stuck in the "Read the Docs" build. Anyone (@andersy005 , @kmpaul ) no how to unstick it?

[jukent]

Should we add joining the email list to the contributor's guide?

---

If you would like join the [email protected] Google group to be informed of updates and events in the seminar series, please do so by following this link and clicking "Join Group" next to the group name.

[jukent]

This PR seems stuck in the "Read the Docs" build. Anyone (@andersy005 , @kmpaul ) no how to unstick it?

When I click "details" it says the build completed. Not sure why it is hanging.

[brian-rose]

Yep, same over at #105. I tried closing and reopening to trigger another build on readthedocs, but still hangs forever. Annoying but seems clear that it has nothing to do with the content of these PRs.

[brian-rose]

I think I got this working again by going over to Read the Docs and clicking on "Resync Webhooks" under the admin tab.

[brian-rose]

Now if we merge main in one more time (which now includes the changes to codeowners from #105), I guess that the review requirements will be met automatically.

Let me try that.

[brian-rose]

Should we add joining the email list to the contributor's guide?

If you would like join the [email protected] Google group to be informed of updates and events in the seminar series, please do so by following this link and clicking "Join Group" next to the group name.

@jukent given the multiple rounds of review on this particular PR, I'd prefer to merge this as-is now. Can you please open a new issue / PR to add the email list info?

[clyne]

I got the green lights, and I squashed and merged before anything else could happen!!! Thanks for sorting this out, @brian-rose