Skip to content

docs: tighten AGENTS.md to project-specific rules #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xerrion merged 1 commit into from
May 7, 2026
Merged

docs: tighten AGENTS.md to project-specific rules #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 14 additions & 51 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,24 @@
# RaidLogAuto - Agent Guidelines
# RaidLogAuto AGENTS.md

## CI/CD

| Workflow | Trigger | What it does |
|----------|---------|--------------|
| `lint.yml` | `pull_request_target` to `master` | Runs Luacheck |
| `release.yml` | Push to `master` | release-please creates/updates a Release PR; dispatches `packager.yml` on release |
| `packager.yml` | `workflow_dispatch` (from release.yml) | Builds and publishes via BigWigsMods packager |

---
Deviates from workspace conventions: no Ace3, no shared `ns`, no AceDB.

## Version-Specific Files

| File | Interface | Game Version | Features |
|------|-----------|--------------|----------|
| RaidLogAuto_Retail.lua | Interface | Retail | Raids + Mythic+ |
| RaidLogAuto_Mists.lua | Interface-Mists | MoP Classic | Raids + Mythic+ |
| RaidLogAuto_TBC.lua | Interface-BCC | TBC Anniversary | Raids |
| RaidLogAuto_Cata.lua | Interface-Cata | Cataclysm Classic | Raids |
| RaidLogAuto_Classic.lua | Interface-Classic | Classic Era | Raids |

---

## Key WoW API Functions Used

| Function | Availability | Purpose |
|----------|--------------|---------|
| `IsInInstance()` | All versions | Check if player is in instance |
| `IsInRaid()` | All versions | Check if player is in raid |
| `LoggingCombat([bool])` | All versions | Get/set combat logging state |
| `C_ChallengeMode.GetActiveChallengeMapID()` | All versions (content in Retail/MoP only) | Get active M+ map ID |
| `C_Timer.After(seconds, func)` | All versions | Delayed function execution |
| `CreateFrame("Frame")` | All versions | Create event frame |

---
| File | TOC Directive | Game Version |
|------|---------------|--------------|
| `RaidLogAuto_Retail.lua` | `## Interface` | Retail (raids + Mythic+) |
| `RaidLogAuto_Mists.lua` | `## Interface-Mists` | MoP Classic (raids + Mythic+) |
| `RaidLogAuto_TBC.lua` | `## Interface-BCC` | TBC Anniversary (raids) |
| `RaidLogAuto_Cata.lua` | `## Interface-Cata` | Cataclysm Classic (raids) |
| `RaidLogAuto_Classic.lua` | `## Interface-Classic` | Classic Era (raids) |

## RaidLogAuto-Specific Patterns
## Namespace Pattern

### Namespace
Use `local ADDON_NAME, _ = ...` - the shared `ns` table is intentionally discarded. Each version-specific file is fully self-contained; do not factor logic into a shared module.

Unlike all other addons in this workspace, RaidLogAuto discards the shared namespace:
## SavedVariables Defaults Merge

```lua
local ADDON_NAME, _ = ...
```

There is no `ns` table. Each version-specific file is fully self-contained.

### SavedVariables Defaults Merge

RaidLogAuto does not use AceDB. Defaults are merged manually in the `ADDON_LOADED` handler:
No AceDB. Defaults are merged manually in the `ADDON_LOADED` handler:

```lua
local defaults = {
Expand All @@ -66,12 +35,6 @@ for key, value in pairs(defaults) do
end
```

---

## Known Gotchas

- `RaidLogAuto.lua` is **deprecated** and excluded from packaging - do not edit it
- Missing APIs for a target version - check `docs/` for the exact client build
- Deprecated globals like `COMBATLOGENABLED` and `COMBATLOGDISABLED` (removed in Cata; always provide `or` fallbacks)
- Race conditions on `PLAYER_ENTERING_WORLD` - use a short `C_Timer.After` delay
- Timer leaks - cancel `C_Timer` or `AceTimer` handles before reusing
- `RaidLogAuto.lua` is **deprecated** and excluded from packaging - do not edit it.