Skip to content

Fix issues and enhance documentation for project health#66

Merged
thealphacubicle merged 2 commits into
mainfrom
develop
Apr 29, 2026
Merged

Fix issues and enhance documentation for project health#66
thealphacubicle merged 2 commits into
mainfrom
develop

Conversation

@thealphacubicle

Copy link
Copy Markdown
Owner

This pull request introduces a comprehensive set of documentation and configuration files that define conventions, workflows, and automation for plugin development, testing, infrastructure, and deployment in the OpenContext project. The changes standardize best practices for Python code style, plugin interface requirements, test structure, AWS/Terraform infrastructure, and provide skill definitions for common workflows. Additionally, it adds agent definitions for automated code review and test writing, as well as settings for tool permissions and formatting hooks.

The most important changes are:

Plugin Development & Code Style

  • Added .claude/rules/plugin-development.md and .claude/rules/code-style.md to define strict conventions for plugin interface implementation, required class attributes and methods, code style (imports, type hints, docstrings, logging, naming), and error handling. These ensure plugins are discoverable and maintainable. [1] [2]
  • Introduced .claude/agents/plugin-validator.md, a specialized agent for reviewing plugin code against the MCPPlugin interface, with a detailed checklist for correctness.

Testing Conventions & Automation

  • Added .claude/rules/testing.md and .claude/agents/test-writer.md to enforce pytest test structure, mocking patterns, coverage requirements, and to automate test writing for plugins and core modules. [1] [2]

Infrastructure & Deployment

  • Documented Terraform/AWS infrastructure conventions in .claude/rules/infrastructure.md, including state management, workspace naming, variable handling, and validation steps.
  • Added skill definitions for deploying to AWS and debugging Lambda in .claude/skills/deploy-aws/SKILL.md and .claude/skills/debug-lambda/SKILL.md, with step-by-step workflows and troubleshooting guides. [1] [2]

Automation & Permissions

  • Introduced .claude/settings.json to manage tool permissions (allow/deny lists for commands and file access) and to automatically format Python files after edits using ruff.

Skill-based Workflows

  • Added .claude/skills/add-plugin/SKILL.md to standardize the process for creating and enabling new plugins, including scaffolding, implementation, testing, and common pitfalls.

Closes #51

thealphacubicle and others added 2 commits April 28, 2026 13:11
* Fix issue template yamllint warnings

* Claude support files

* bug fix with terraform validation in CLI

* Updated docs to be UV native

* Docs fix + test case bug fix

* Update .claude/rules/code-style.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* PR fixes

* PR fixes

---------

Co-authored-by: Srihari Raman <raman.sr@northeastern.edu>
Co-authored-by: Srihari Raman <srihariraman@Sriharis-MacBook-Pro.local>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Srihari Raman <srihariraman@Sriharis-MacBook-Pro.local>
@thealphacubicle thealphacubicle self-assigned this Apr 29, 2026
@thealphacubicle thealphacubicle added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 29, 2026
@thealphacubicle
thealphacubicle merged commit c099323 into main Apr 29, 2026
6 checks passed
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 enhancement New feature or request

Projects

Development

Successfully merging this pull request may close these issues.

[Epic] Project Health & Documentation

1 participant