Skip to content

Add contributor guide and agent docs (#295)#303

Open
KemGus wants to merge 1 commit into
ACE-Project-Team:devfrom
KemGus:docs/contributor-ai-rules
Open

Add contributor guide and agent docs (#295)#303
KemGus wants to merge 1 commit into
ACE-Project-Team:devfrom
KemGus:docs/contributor-ai-rules

Conversation

@KemGus

@KemGus KemGus commented Jul 23, 2026

Copy link
Copy Markdown
Member

Adds contributor and agent documentation (part of #295).

  • CONTRIBUTING.md — workflow, PR expectations, code style (links to the ACE + CFC style guides and .glualint.json), an LDoc doc-comment convention, testing entry points, and the AI-assisted contributions policy (adapted from Wiremod's).
  • AGENTS.md — short entry point for coding agents: must-read links, an honesty rule, and fast facts (LF, ACE. namespace, tests/lint). Read by Codex and other AGENTS.md-aware tools.
  • CLAUDE.md — points Claude Code at AGENTS.md (single source of truth).

Line-ending guidance is LF going forward.

Scoped to docs only. Follow-ups from #295 (separate PRs): LDoc generation tooling, and the wiki/dev-board MCP.

@KemGus

KemGus commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

So this is the beginning I believe, next thing I will do is create an MCP or some API idk for a website, that model can also call to cite human written text. I am not going to make it work with dev wiki, as there is no point, just the wiki itself rather.

@KemGus

KemGus commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

@Ally-for-Hire also lmk if I did write it correctly with tests and such please check

@Ally-for-Hire

Copy link
Copy Markdown
Collaborator

yeah i only see mds so it looks good to me

@Ally-for-Hire

Copy link
Copy Markdown
Collaborator

i like this, id add our general rules/style into it among other things. i can possibly look into this. having a shared llm library/abilities would be kind of huge for the mod.

@Ally-for-Hire Ally-for-Hire added type: documentation area: core Lifecycle, contraptions, legality, points, caches, or shared systems. area: ui and removed type: documentation area: core Lifecycle, contraptions, legality, points, caches, or shared systems. area: ui labels Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: core Lifecycle, contraptions, legality, points, caches, or shared systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants