processing / processing/p5.js

Current status of maintenance tasks, package audits, tracking tech debt, etc

Open
#7,069 2 comments 0 reactions 1 assignee View on GitHub

@Qianqianye is already working on this.

Since Jun 18, 2024.

Discussion p5.js 2.0+
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

Topic
Context:

Node 16 reached its end of life in September 2023 which may have prompted us to switch to Node 20. However, this wasn't done consistently for all jobs within Github Actions workflows (some jobs in release workflow still use Node 12 or Node 16).

I happened to notice deprecation warnings on Github Actions regarding the use of old refs in release, lint and test workflows. I attempted fixing some of these warnings on my fork.

Further, there are package vulnerabilities owing to old versions of dependencies.
While the fixes for the above are trivial, it seems like these warnings have started piling up and its a matter of time before they become unmanageable and/or introduce breaking changes if not maintained regularly.

There are other maintenance tasks that are quite relevant, such as an upgrade to p5's build and test systems (#7013), updating docs, etc.

I could not find a process or documentation to attend these tasks, hence reaching out for a discussion. It would greatly help if someone could point me to a process doc for maintenance issues with workflows, package audits, build, test systems and allied topics.

In case such a process does not exist yet, I would like to propose the following:

Proposal:
  1. Add an Issue category for maintenance and audit tasks so that we could track and attend to them separate from feature, enhancement, and bug fixes
  2. Formulate a plan to consciously audit, maintain, upgrade packages, update documentation on a regular basis by setting priorities to these tasks, calling for contributions, and so on

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.