ludusavi-manifest/CONTRIBUTING.md

Development

Requires Node.js.

Generally, you just need these commands:

• Add all recent changes (defaults to last 7 days, but then it remembers when you last ran it):
  • npm run recent
• Validate the manifest against the schema:
  • npm run schema
• List some stats about the data set:
  • npm run stats
• Activate pre-commit hooks (requires Python):

  pip install --user pre-commit
  pre-commit install
  

There are some lower-level commands for finer control or full imports:

• Add new games to wiki-game-cache.yaml (required in order to add them to the manifest):
  • npm run cache
• Update the manifest with games from the cache (--limit 25 is default at a time):
  • All games in cache: npm run manifest -- --all
  • Games already in the manifest: npm run manifest -- --existing
  • Games missing from manifest: npm run manifest -- --missing
  • Games not yet checked on the wiki: npm run manifest -- --unchecked
  • Games that had an unknown OS: npm run manifest -- --unsuportedOs
  • Games that had an unusable path: npm run manifest -- --unsupportedPath
  • Games with paths that are too broad and are tagged as such in the wiki cache: npm run manifest -- --tooBroad
  • Games with paths that are too broad and aren't already tagged as such in the wiki cache: npm run manifest -- --tooBroadUntagged
  • Games with paths that look invalid and are tagged as such in the wiki cache: npm run manifest -- --irregularPath
  • Games with paths that look invalid and aren't already tagged as such in the wiki cache: npm run manifest -- --irregularPathUntagged
  • A specific game: npm run manifest -- "Game 1" "Game 2"
  • In any above command, skip games alphabetically prior to a particular one: --skipUntil 'Game 3'

API etiquette

When running or modifying the importer script, please be mindful not to unnecessarily spam the PCGW or Steam APIs.

The Mediawiki guidelines suggest that:

Making your requests in series rather than in parallel, by waiting for one request to finish before sending a new request, should result in a safe request rate.

I am not sure about guidelines for the Steam API, but the cache file should mean that we only ever need to reach out to Steam once per game.