Skip to content

chore: add AGENTS.md, drop dead JavaScript-era files - #4

Merged
Unisay merged 1 commit into
masterfrom
chore/agents-md-and-canon-ci
Jun 14, 2026
Merged

chore: add AGENTS.md, drop dead JavaScript-era files#4
Unisay merged 1 commit into
masterfrom
chore/agents-md-and-canon-ci

Conversation

@Unisay

Copy link
Copy Markdown
Collaborator

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.md is 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.md is a one-line @AGENTS.md import so Claude Code reads the same file instead of a second copy that drifts out of sync.

It drops .eslintrc.json, bower.json, package.json left 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.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md documenting build/test/lint commands, Lua 5.1 constraints, FFI parenthesisation, and toolchain pins.
  • Add CLAUDE.md to delegate Claude Code instructions to AGENTS.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
FileDescription
AGENTS.mdAdds agent-facing repo commands + Lua 5.1/FFI/toolchain guidance.
CLAUDE.mdImports AGENTS.md so Claude Code uses the same instruction source.
package.jsonRemoves obsolete npm/pulp/eslint-era configuration.
bower.jsonRemoves obsolete bower-era package metadata.
.eslintrc.jsonRemoves obsolete ESLint configuration tied to the removed JS toolchain.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadAGENTS.md
@Unisay
Unisayforce-pushed the chore/agents-md-and-canon-ci branch 3 times, most recently from 6577d55 to 9ff355cCompareJune 14, 2026 17:11
@Unisay
Unisay marked this pull request as ready for review June 14, 2026 17:12
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.
@Unisay
Unisayforce-pushed the chore/agents-md-and-canon-ci branch from 9ff355c to 0c0ed62CompareJune 14, 2026 17:18
@Unisay
Unisay merged commit 12904bf into masterJun 14, 2026
1 check passed
@Unisay
Unisay deleted the chore/agents-md-and-canon-ci branch June 14, 2026 17:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@Unisay