25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
# Agent Rules
|
|
|
|
This repository is operated in an autonomous, documentation-first mode.
|
|
|
|
## Workflow
|
|
|
|
1. Start from official 3proxy documentation before changing runtime behavior.
|
|
2. Update `docs/PLAN.md` and `docs/PROJECT_INDEX.md` immediately after meaningful changes.
|
|
3. Prefer small, reviewable commits with descriptive messages after each completed batch of work.
|
|
4. Write tests for edge cases and failure modes, not only happy paths.
|
|
5. Never overwrite or revert user changes unless explicitly requested.
|
|
|
|
## Engineering Preferences
|
|
|
|
- Build UI and domain logic with clear separation so 3proxy runtime integration can replace mocks without redesign.
|
|
- Keep the panel informative, low-noise, and keyboard friendly.
|
|
- Default to explicit states for live, degraded, failed, quota warning, and unlimited quota.
|
|
- Treat credentials, config generation, and process control as security-sensitive code paths.
|
|
|
|
## Project Conventions
|
|
|
|
- Keep project documentation current in `docs/`.
|
|
- Add concise comments only where the intent is not obvious from code.
|
|
- Use ASCII unless the file already requires Unicode content.
|