Skip to content

docs: add agent skills and instructions for autonomous coding - #686

Merged
firstof9 merged 3 commits into
mainfrom
add-agent-skills-instructions
Aug 21, 2026
Merged

docs: add agent skills and instructions for autonomous coding#686
firstof9 merged 3 commits into
mainfrom
add-agent-skills-instructions

Conversation

@firstof9

@firstof9 firstof9 commented Aug 21, 2026

Copy link
Copy Markdown
Owner

Description

This PR introduces comprehensive repository-specific agent guidelines and on-demand workspace skills to assist AI and agentic coding assistants working in python-openevse-http.

Summary of Additions:

  • AGENTS.md: Top-level instructions covering:
    • Architecture & Mixins: OpenEVSE lifecycle, CommandsMixin, PropertiesMixin, SensorsMixin, WebsocketMixin, and external session requirements.
    • Firmware Version Handling & Upstream Validation: Guidance for _version_check() thresholds and cross-referencing upstream repositories (ESP32_WiFi_V4.x, ESP8266_WiFi_v2.x, and open_evse) for route methods, payloads, and RAPI command specs.
    • Exception Hierarchy: Base OpenEVSEError and typed error conventions (CommandFailedError, UnknownStateError, FirmwareResolutionError).
    • Testing & Mocking: Fixtures (test_charger, mock_aioclient), JSON fixtures, and pytest-asyncio loop handling.
    • PR & Issue Conventions: Semantic commit titles, mandatory PR template usage, and bug report/feature request issue templates.
  • .agents/skills/openevse-dev-workflow/SKILL.md: On-demand workflow skill for:
    • Running full and targeted unit tests via tox -e py314 and .tox/py314/bin/pytest.
    • Auto-formatting and lint fixing with Ruff.
    • Static type checking with Mypy.
    • Pull request and issue creation instructions.
  • .agents/skills/openevse-api-guide/SKILL.md: On-demand reference skill for:
    • HTTP REST endpoints vs RAPI command fallbacks.
    • Upstream firmware repository validation checklist.
    • Firmware version branching and exception handling patterns.
    • Best practices for writing command tests.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code quality / Refactoring
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

- Add AGENTS.md with architecture overview, mixin design, session rules, testing patterns, and PR guidelines
- Add openevse-dev-workflow skill for running test, lint, and typecheck commands
- Add openevse-api-guide skill for endpoints, RAPI commands, version checks, and exception conventions
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 21, 2026
@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 63d9a360-cffa-440f-ae01-b314527db7e5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@firstof9
firstof9 merged commit 8036425 into main Aug 21, 2026
16 of 17 checks passed
@firstof9
firstof9 deleted the add-agent-skills-instructions branch August 21, 2026 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant