chore: add AGENTS.md, drop dead JavaScript-era files#4
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds unified AI-agent/contributor instructions for the PureScript→Lua fork (Lua 5.1 target) and removes leftover JavaScript-era tooling files that are no longer part of the nix+spago workflow.
Changes:
- Add
AGENTS.mddocumenting build/test/lint commands, Lua 5.1 constraints, FFI parenthesisation, and toolchain pins. - Add
CLAUDE.mdto delegate Claude Code instructions toAGENTS.md. - Remove legacy JS toolchain config files (
package.json,bower.json,.eslintrc.json).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Adds agent-facing repo commands + Lua 5.1/FFI/toolchain guidance. |
| CLAUDE.md | Imports AGENTS.md so Claude Code uses the same instruction source. |
| package.json | Removes obsolete npm/pulp/eslint-era configuration. |
| bower.json | Removes obsolete bower-era package metadata. |
| .eslintrc.json | Removes obsolete ESLint configuration tied to the removed JS toolchain. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
6577d55 to
9ff355c
Compare
AGENTS.md is the single instruction file the coding agents read natively; CLAUDE.md is a one-line @AGENTS.md import so Claude Code shares it. Also removes dead bower.json/package.json/.eslintrc.json. CI is already on the shared canon; no src/ change.
9ff355c to
0c0ed62
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fork's CI is already on the shared canon, so this is docs and cleanup only: it adds the AI-agent instructions and clears out the dead JavaScript-era files.
AGENTS.md+CLAUDE.md:AGENTS.mdis the one instruction file the coding agents read natively (Codex, Cursor, Copilot, Gemini CLI, Aider): the build/test/lint commands, the Lua 5.1 constraints, the FFI parenthesisation rule, and the toolchain pins.CLAUDE.mdis a one-line@AGENTS.mdimport so Claude Code reads the same file instead of a second copy that drifts out of sync.It drops
.eslintrc.json,bower.json,package.jsonleft over from the JavaScript build; the toolchain is spago plus nix now.No
src/change, so there is no tag or package-set bump.Verification
nix develop -c ./scripts/build, the regression suite, and luacheck are clean locally.