search

chip-8 / chip-8-database

A database of CHIP-8 ROM metadata
Other
17 stars 3 forks source link

Make contributing easier #19

Closed Estus-Dev closed 3 months ago

Estus-Dev commented 3 months ago

I've added a Contributing section to the README, detailing how to add new programs to the list without being rejected by CI.

I've also fixed a bug that's bitten me both times I've contributed in the past, where scripts/update-chip8-archive.js would inject invalid colors into existing entries, causing schema validation to fail.

This was caused by the Chip8Archive's programs.json file containing programs where no colors were specified.

In future I'd like to automatically create (draft) PRs for updates to the Chip8Archive, at which point we could remove that source of friction from new manual PRs and simplify the README I just added.

Estus-Dev commented 3 months ago

EDIT: Didn't refresh the page before commenting.

I figured it'd be easier to make the changes I proposed than to get signoff first and then make them and then have you review them again.

In particular, I moved the updating section to the bottom of the page because it's still useful to have documented, but I removed the incorrect info about CI.

I changed the commands around as I suggested, so npm start and npm test are all a new contributor needs to know, while leaving npm run update for pulling from upstream.