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

Contributor git workflow clarification #6829

Closed RandomGamingDev closed 4 months ago

RandomGamingDev commented 4 months ago

Resolves #6828

Changes:

Changes the wording to clarify the fact that npm test has to be ran once before running npm run build.

PR Checklist

limzykenneth commented 4 months ago

It might be possible to make npm run build work directly after install so we don't need to necessarily recommend running npm test first. I can look into it once I get some time.

RandomGamingDev commented 4 months ago

It might be possible to make npm run build work directly after install so we don't need to necessarily recommend running npm test first. I can look into it once I get some time.

It's been quite a bit of time from you're original comment. Have you already tested whether it's possible on certain setups?

On the setups I've tested it doesn't seem to work since npm run build requires a file generated by calling npm test.

limzykenneth commented 4 months ago

Fixed with https://github.com/processing/p5.js/commit/f14a45e3aa7324329711506fdccf391c6b67d39e

@RandomGamingDev In the future it can help greatly if you can provide more information around replication and expected vs actual output, that way we don't need to spend time on replication. Eg. the relevant error message here is

Fatal error: Cannot find module '../../../docs/parameterData.json' from '/home/limzykenneth/Documents/p5.js/src/core/friendly_errors'

Just knowing this narrows down the fix faster. Thanks.

RandomGamingDev commented 4 months ago

Fixed with f14a45e

@RandomGamingDev In the future it can help greatly if you can provide more information around replication and expected vs actual output, that way we don't need to spend time on replication. Eg. the relevant error message here is

Fatal error: Cannot find module '../../../docs/parameterData.json' from '/home/limzykenneth/Documents/p5.js/src/core/friendly_errors'

Just knowing this narrows down the fix faster. Thanks.

That's indeed the error. Sorry for not providing more information and thanks for the fix.