Métriques du dépôt
- Stars
- (20 784 stars)
- Métriques de merge PR
- (Merge moyen 8j 13h) (45 PRs mergées en 30 j)
Description
Topic
Hi, I am a new contributor and have been working on documentation fixes for the past week with (@thatguyseven, @snwarner22, @OnexiMedina, @emmet0r). We noticed the following advice on the p5.js website:
-
If you're just getting started, one really helpful way you can contribute is by opening issues for documentation needs. If you notice a typo, a missing or broken example, or a function description that is confusing, open an issue for it! Please include a link to the page that needs fixing so we can find it easily. -
Read through the reference, and look for typos, broken examples, or confusing documentation. If it's a straightforward fix, go ahead and work on it! If it's a more involved question that requires discussion, create an issue.
What is the expected contribution workflow for a documentation fix? So far we have been opening issues, but based on the above don't know if this is necessary for simple edits (typos, capitalization).
We would love to help improve access for new users. If there is interest in clarifying expectations in the Contributor Guidelines, we would love to work on it. If issues are desired for every documentation edit, we could add a Documentation issue template (with automatic tagging), which could make issue-reviewing smoother for stewards and maintainers.