processing / processing/p5.js

Clarifying Doc Contribution Workflow

Open
#6,305 11 comments 0 reactions 1 assignee View on GitHub

@thatguyseven is already working on this.

Since Jul 31, 2023.

Discussion Help Wanted
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

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:

  1. 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.

  2. 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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.