Skip to content

Commit dac62d7

Browse files
chore: set up Copilot coding agent instructions (#74)
* chore: set up Copilot instructions Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com> * chore: make AGENTS.md canonical, symlink copilot-instructions.md to it - Merge unique content (project description, Architecture section) from .github/copilot-instructions.md into AGENTS.md - Replace .github/copilot-instructions.md with a symlink to ../AGENTS.md Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com> * chore: fix FlameConnect space --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com> Co-authored-by: Andrew Berry <andrew@furrypaws.ca>
1 parent e2e06fb commit dac62d7

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../AGENTS.md

AGENTS.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Agents
22

3+
Flame Connect is an async Python library for controlling Dimplex, Faber, and Real Flame fireplaces via the Flame Connect cloud API. It includes a CLI and an optional TUI dashboard.
4+
35
## Package Management
46

57
This project uses [`uv`](https://docs.astral.sh/uv/) for package management. Do **not** use `pip` directly.
@@ -29,11 +31,20 @@ Use [conventional commit](https://www.conventionalcommits.org/) formatting for p
2931
## Development
3032

3133
```bash
32-
3334
# Lint and type-check
3435
uv run ruff check .
3536
uv run mypy src/
3637

3738
# Run tests
3839
uv run pytest
3940
```
41+
42+
## Architecture
43+
44+
- The library is async-first, using `aiohttp` for HTTP communication.
45+
- Authentication is handled via `msal` against Azure AD B2C.
46+
- The optional TUI is built with the `textual` framework (installed via the `tui` extra).
47+
- Strict `mypy` type checking is enforced across the entire `src/` directory.
48+
- Test coverage must remain at or above 95%.
49+
- New code must include corresponding tests.
50+

0 commit comments

Comments
 (0)