Skip to content
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

Update contributing guidance #30

Open
MathewBiddle opened this issue Apr 15, 2024 · 1 comment
Open

Update contributing guidance #30

MathewBiddle opened this issue Apr 15, 2024 · 1 comment

Comments

@MathewBiddle
Copy link

https://github.com/ioos/ioos-python-package-skeleton/blob/main/CONTRIBUTING.md

We should update this to be more specific about how folks should be interacting with these doc sites.

from @dpsnowden:

do I work on main or gh-pages? and Do I commit directly if I'm working on a site with other people or do I fork/pr?

I see two cases:

  1. Those who have admin privs. (don't need to fork)
  2. Those who don't. (need to fork)

We can build off https://github.com/ioos/ioos_code_lab/blob/main/CONTRIBUTING.md#building-new-notebooks

@ocefpaf
Copy link
Member

ocefpaf commented Apr 15, 2024

Ideally everybody, including those who have admin rights, should fork. Sending PRs directly, without a fork, can leak secrets and/or trigger workflows that are not meant to run until the PR is merge. Like publishing a site while still iterating the commits.

Regarding the branch, that is more complicated b/c it depends on the repo. My guess is that all of IOOS documentation are in the gh-pages branch. However, they can be on main in if we wish to do so.

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

No branches or pull requests

2 participants