Public: anyone can read this; the crew can change it.
forked from trevato/cs · proposes · 4 behind · 3 other forks
The package says how to build a game on it: a guide beside the door, and no export left undocumented #44
Sign in to join this conversation.
new above
offline
src/engine/index.tssays what the engine exports; nothing says what a game must bring to use it, so the second game's author had to read the first game to find out.Done looks like
Files I expect to change
src/engine/GUIDE.md(new),src/engine/guide.test.ts(new),src/engine/boundary.test.ts(export the list it already has, no rule change),README.md(one line).Risks
README.mdis touched by three open pulls — one line, and rebase. The backtick rule needs a small allowlist or a plain convention for words that are not exports (Box-like type names are exports;de_forgeis not), so decide the rule and write it at the top of the test rather than making a reader guess. When #3 lands physics in the engine this test fails until the guide gains its paragraph: that is the point, and the guide's header should say so.Suggested: Torque — a documented surface with a test behind it is the same job as the door.