ioos / ioos/ioos-python-package-skeleton
Update contributing guidance
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 11
- Forks
- 10
- Avg merge
- 41m
- Merged PRs (30d)
- 11
Description
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:
- Those who have admin privs. (don't need to fork)
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with CONTRIBUTING.md and compare it with the linked ioos_code_lab CONTRIBUTING.md#building-new-notebooks guidance. Document how contributors should work on main or gh-pages, and when administrators can commit directly versus when others should use a fork and pull request. Done means both contributor cases and the doc-site workflow are explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github, jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100