refactor(docs): update references from copilot-instructions.md to AGENTS.md across documentation

This commit is contained in:
Julian Pawlowski 2025-11-10 14:09:40 +00:00
parent 6e1a3e37c5
commit 6a77572f4e
7 changed files with 20 additions and 20 deletions

View file

@ -92,7 +92,7 @@ When working with the codebase, Copilot MUST actively maintain consistency betwe
**Update Proposal Format:**
Include confidence level and impact in proposals:
> **[🔴 HIGH]** I noticed the translation pattern in copilot-instructions.md references `enrich_price_info_with_differences()` in `price_utils.py`, but this function was renamed to `enrich_prices()`.
> **[🔴 HIGH]** I noticed the translation pattern in AGENTS.md references `enrich_price_info_with_differences()` in `price_utils.py`, but this function was renamed to `enrich_prices()`.
>
> **Impact:** Future sessions will look for wrong function name.
>
@ -406,7 +406,7 @@ Combine into single commit when:
> **Stage these files:**
>
> ```bash
> git add pyproject.toml .github/copilot-instructions.md
> git add pyproject.toml AGENTS.md
> ```
>
> **Commit message:**
@ -417,7 +417,7 @@ Combine into single commit when:
> Consolidated ruff configuration into pyproject.toml following modern Python
> conventions and integration_blueprint pattern.
>
> Updated all references in copilot-instructions.md from .ruff.toml to
> Updated all references in AGENTS.md from .ruff.toml to
> pyproject.toml under [tool.ruff] section.
>
> Impact: Aligns with modern Python tooling standards. No user-visible changes.
@ -451,7 +451,7 @@ Combine into single commit when:
> **Commit 2: Documentation**
>
> ```bash
> git add .github/copilot-instructions.md
> git add AGENTS.md
> ```
>
> ```
@ -532,7 +532,7 @@ encountering errors.
```
docs(workflow): add git commit guidance for release notes
Added comprehensive "Git Workflow Guidance" section to copilot-instructions.md
Added comprehensive "Git Workflow Guidance" section to AGENTS.md
documenting when AI should suggest commits, Conventional Commits format, and
how to structure technical messages that enable future release note generation.
@ -574,7 +574,7 @@ refactor: migrate ruff config from .ruff.toml to pyproject.toml
Consolidated ruff configuration into pyproject.toml following modern Python
conventions and integration_blueprint pattern.
Updated all references in copilot-instructions.md from .ruff.toml to
Updated all references in AGENTS.md from .ruff.toml to
pyproject.toml under [tool.ruff] section.
Impact: Aligns with modern Python tooling standards. No user-visible changes.

View file

@ -12,7 +12,7 @@ Thank you for your interest in contributing! This document provides guidelines f
For detailed developer documentation, see [docs/development/](docs/development/).
> **Note:** This project is developed with extensive AI assistance (GitHub Copilot, Claude). If you're also using AI tools, check [`.github/copilot-instructions.md`](/.github/copilot-instructions.md) for patterns and conventions that ensure consistency.
> **Note:** This project is developed with extensive AI assistance (GitHub Copilot, Claude). If you're also using AI tools, check [`AGENTS.md`](/AGENTS.md) for patterns and conventions that ensure consistency.
## Getting Started
@ -81,7 +81,7 @@ Added new sensor that calculates average price for the entire day.
Impact: Users can now track daily average prices for cost analysis."
```
See `.github/copilot-instructions.md` section "Git Workflow Guidance" for detailed guidelines.
See [`AGENTS.md`](AGENTS.md) section "Git Workflow Guidance" for detailed guidelines.
## Submitting Changes
@ -143,7 +143,7 @@ Report bugs via [GitHub Issues](../../issues/new/choose).
## Questions?
- Check [Developer Documentation](docs/development/)
- Read [Copilot Instructions](.github/copilot-instructions.md) for patterns
- Read [Copilot Instructions](AGENTS.md) for patterns
- Search [existing issues](https://github.com/jpawlowski/hass.tibber_prices/issues)
- Open a [new issue](https://github.com/jpawlowski/hass.tibber_prices/issues/new)

View file

@ -521,7 +521,7 @@ def _build_period_summary_dict(
Complete period summary dictionary following attribute ordering
"""
# Build complete period summary (following attribute ordering from copilot-instructions.md)
# Build complete period summary (following attribute ordering from AGENTS.md)
summary = {
# 1. Time information (when does this apply?)
"start": period_data.start_time,

View file

@ -12,7 +12,7 @@ This section contains documentation for contributors and maintainers of the Tibb
## 🤖 AI Documentation
The main AI/Copilot documentation is in [`.github/copilot-instructions.md`](../../.github/copilot-instructions.md). This file serves as long-term memory for AI assistants and contains:
The main AI/Copilot documentation is in [`AGENTS.md`](../../AGENTS.md). This file serves as long-term memory for AI assistants and contains:
- Detailed architectural patterns
- Code quality rules and conventions
@ -20,7 +20,7 @@ The main AI/Copilot documentation is in [`.github/copilot-instructions.md`](../.
- Common pitfalls and anti-patterns
- Project-specific patterns and utilities
**Important:** When proposing changes to patterns or conventions, always update `copilot-instructions.md` to keep AI guidance consistent.
**Important:** When proposing changes to patterns or conventions, always update [`AGENTS.md`](../../AGENTS.md) to keep AI guidance consistent.
### AI-Assisted Development
@ -50,7 +50,7 @@ This integration is developed with extensive AI assistance (GitHub Copilot, Clau
- Translation quality depends on AI's understanding of target language
- User feedback is crucial for discovering real-world issues
If you're working with AI tools on this project, the `copilot-instructions.md` file provides the context and patterns that ensure consistency.
If you're working with AI tools on this project, the [`AGENTS.md`](../../AGENTS.md) file provides the context and patterns that ensure consistency.
## 🚀 Quick Start for Contributors
@ -130,7 +130,7 @@ pytest --cov=custom_components.tibber_prices tests/
- **User-facing docs** go in `docs/user/`
- **Developer docs** go in `docs/development/`
- **AI guidance** goes in `.github/copilot-instructions.md`
- **AI guidance** goes in `AGENTS.md`
- Use clear examples and code snippets
- Keep docs up-to-date with code changes

View file

@ -1,6 +1,6 @@
# Architecture
> **Note:** This guide is under construction. For now, please refer to `.github/copilot-instructions.md` for detailed architecture information.
> **Note:** This guide is under construction. For now, please refer to [`AGENTS.md`](../../AGENTS.md) for detailed architecture information.
## Core Components
@ -18,4 +18,4 @@
- **Quarter-hour precision**: Entity updates on 00/15/30/45 boundaries
- **Intelligent caching**: User data (24h), price data (calendar day validation)
See `.github/copilot-instructions.md` "Architecture Overview" section for complete details.
See [`AGENTS.md`](../../AGENTS.md) "Architecture Overview" section for complete details.

View file

@ -1,6 +1,6 @@
# Coding Guidelines
> **Note:** For complete coding standards, see `.github/copilot-instructions.md`.
> **Note:** For complete coding standards, see `AGENTS.md`.
## Code Style
@ -50,4 +50,4 @@ enriched = enrich_price_info_with_differences(
)
```
See `.github/copilot-instructions.md` for complete guidelines.
See [`AGENTS.md`](../../AGENTS.md) for complete guidelines.

View file

@ -1,6 +1,6 @@
# Development Setup
> **Note:** This guide is under construction. For now, please refer to `.github/copilot-instructions.md` for detailed setup information.
> **Note:** This guide is under construction. For now, please refer to [`AGENTS.md`](../../AGENTS.md) for detailed setup information.
## Prerequisites
@ -50,4 +50,4 @@ Visit http://localhost:8123
./scripts/lint-check
```
See `.github/copilot-instructions.md` for detailed patterns and conventions.
See [`AGENTS.md`](../../AGENTS.md) for detailed patterns and conventions.