Imported from HappyCool121/ntu-planner-core (
AGENTS.md). Install upstream withnpx skills add HappyCool121/ntu-planner-core. Copyright stays with the author.
NTU Planner Core contributor instructions
- Use Node.js 24 and the checked-in npm lockfile. Run
npm run typecheckandnpm testbefore committing. - This repository is a curated, MIT-licensed reference core, not the deployed Orbit application. Keep React UI, browser storage, sharing/export, HTTP routes, deployment configuration, production identifiers, private history, and personal samples out.
- Preserve public data contracts and deterministic behavior. Do not add runtime dependencies without an explicit need and lockfile review.
- Use synthetic inline fixtures and mocked fetch responses. Never commit credentials, original PDFs, screenshots, student data, or personal filenames; tests must not contact live NTU endpoints.
- Synchronize only the allowlist documented in the private archive record, reviewing every diff rather than copying directories wholesale.