This repository contains generic LLM agent rules that can be shared across multiple projects.
All shared LLM rules are located directly in the root directory:
onboard-agent.md- Standardized agent onboarding processcommit.md,create-branch.md,rebase-branch.md- Git workflowswrite-docs.md,write-card-description.md,create-rule.md- Documentation creationupdate-submodule.md,get-latest-rules.md- Submodule management
These rules are designed to be used as a git submodule in project repositories:
git submodule add https://github.com/beyondessential/llm-rules.git llm/common-rulesLLM agents should reference rules using the path: llm/common-rules/[rule-name].md
If you see an empty llm/common-rules/ folder after pulling:
# Run this in your main repo directory
git submodule update --init --recursiveManual updates (run occasionally):
git pull --recurse-submodulesMake it completely automatic (optional):
# Set up a post-merge hook to auto-update submodules after every pull
echo "git submodule update --remote --merge" > .git/hooks/post-merge
chmod +x .git/hooks/post-mergeAfter setting up the hook, submodules will update automatically whenever you git pull.
To update a rule and sync it everywhere:
Tell the AI: "use the update-submodule.md rule to update [rule name]" - it will handle the submodule workflow for you.
Manual process:
# Make changes in the submodule
cd llm/common-rules
# ... make changes ...
git add . && git commit -m "feat: improve rule X"
git push
# Update main project to use the latest
cd ../../
git submodule update --remote llm/common-rules
git add llm/common-rules
git commit -m "deps: update shared LLM rules"When adding or updating rules:
- Keep rules generic and project-agnostic
- Use Australian/NZ English spelling and terminology
- Test rules across different project contexts
- Follow the established rule structure (Context, Process, Avoid, Notes)