chore: add AGENTS.md + CLAUDE.md, clean JS cruft#3
Merged
Conversation
Add the single agent instruction file (AGENTS.md) and the CLAUDE.md @-import the set standardises on; this fork has no hand-written FFI so luacheck runs over dist/. Drop dead .eslintrc.json/package.json, trim stale .gitignore entries, bump the pslua pin to current main. Tooling and docs only.
There was a problem hiding this comment.
Pull request overview
This PR standardizes agent documentation for the repo and removes legacy JavaScript tooling artifacts, while also updating the Nix flake lock to a newer pslua revision in the purescript-lua toolchain.
Changes:
- Add
AGENTS.md(primary agent instructions) andCLAUDE.md(import stub). - Remove dead JS tooling files (
package.json,.eslintrc.json) and simplify.gitignore. - Update the
psluapin inflake.lock.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
AGENTS.md |
Adds contributor/agent guidance for building/linting and Lua 5.1 constraints. |
CLAUDE.md |
Adds a one-line import pointing to AGENTS.md. |
.gitignore |
Replaces legacy ignore entries with a broad dotfile ignore + exceptions. |
flake.lock |
Bumps the locked pslua revision/hash. |
package.json |
Removes unused npm-based build/test tooling definition. |
.eslintrc.json |
Removes unused ESLint configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Follows up #2 (which moved the fork onto the overlay canon) by adding the agent instructions the set now standardises on, plus a small cleanup.
AGENTS.mdis the single instruction file the coding agents read;CLAUDE.mdis a one-line@AGENTS.mdimport. This fork is pure PureScript overunsafeCoercewith no hand-written FFI, so the lint and the AGENTS.md note point at the generateddist/..eslintrc.jsonandpackage.jsonand trims the stale JavaScript entries from.gitignore.Tooling and docs only, no
src/change.Verification
nix develop -c ./scripts/buildwritesdist/Safe_Coerce.luaand luacheck with--std lua51 --no-unused-args dist/is clean locally.