processing / processing/p5.js

require `describe()` function in p5 sketches?

Open
#5,427 12 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area:Accessibility Discussion Enhancement
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

I was wondering what others think about the idea of potentially requiring a describe() line in order for a p5 sketch to run?

How would this new feature help [increase access]:

This would increase the accessibility of p5.js sketches for people that are Blind or have visual impairments. Considering the way p5.js use continues to expand in education, as well as other spaces like NFTs, this decision could potentially have a large impact.

It's important to note that this could potentially increase the barrier a bit for those that are new to p5.js. On the other hand, it could be a way to spread awareness, through teachers and documentation that teach what this function is and how to use it. The function itself is very straightforward to use.

As a less intense version of this, it could be that the sketch template includes a describe line, but doesn't require it to run.

Most appropriate sub-area of p5.js?
  • [ x ] Accessibility (Web Accessibility)
  • [ x ] Core/Environment/Rendering

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.

Research direction

The issue does not name files, tests, or an implementation entry point. It proposes requiring or templating describe() for accessibility, so clarify the desired behavior and acceptance criteria before identifying what to run and what completion means.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
accessibility, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.