Documentation: Clarification of the necessity of `npm test` before `npm run build` for the Git Workflow portion of the Contributor Docs - Githubissues

processing / p5.js

p5.js is a client-side JS platform that empowers artists, designers, students, and anyone to learn to code and express themselves creatively on the web. It is based on the core principles of Processing. http://twitter.com/p5xjs —

http://p5js.org/

GNU Lesser General Public License v2.1

21.13k stars 3.23k forks source link

Documentation: Clarification of the necessity of `npm test` before `npm run build` for the Git Workflow portion of the Contributor Docs #6828

Closed RandomGamingDev closed 4 months ago

RandomGamingDev commented 4 months ago

Increasing access

This would make it easier for those who aren't used to p5.js to understand what's going wrong when npm run build fails since https://github.com/processing/p5.js/blob/main/contributor_docs/contributor_guidelines.md#git-workflow can, to many, imply that npm test is unnecessary if you simply want to build the repo despite it needing to be ran at least once before npm run build is ran.

Most appropriate sub-area of p5.js?

[ ] Accessibility
[ ] Color
[ ] Core/Environment/Rendering
[ ] Data
[ ] DOM
[ ] Events
[ ] Image
[ ] IO
[ ] Math
[ ] Typography
[ ] Utilities
[ ] WebGL
[ ] Build process
[ ] Unit testing
[ ] Internationalization
[ ] Friendly errors
[X] Other (specify if possible)

Feature enhancement details

Change the wording to make it very clear that running npm test once before running npm run build is required.