Skip to content

[FEAT]: Setup agents.md file with relevant skills for the repo#446

Open
AshutoshDash1999 wants to merge 2 commits into
sreerevanth:mainfrom
AshutoshDash1999:feat/agents-skills-setup
Open

[FEAT]: Setup agents.md file with relevant skills for the repo#446
AshutoshDash1999 wants to merge 2 commits into
sreerevanth:mainfrom
AshutoshDash1999:feat/agents-skills-setup

Conversation

@AshutoshDash1999

@AshutoshDash1999 AshutoshDash1999 commented Jun 19, 2026

Copy link
Copy Markdown

Description

  • AGENTS.md file is added
  • Relevant skills are added
  • Command for installing latest nextjs docs is added as well

Closes #231

Skill Use Case
docker-expert Optimize Dockerfiles, harden container security, design multi-stage builds, troubleshoot compose setups
python-design-patterns Refactor God classes, pick composition vs inheritance, reduce coupling, structure new services cleanly
python-observability Add structured logging, wire up Prometheus metrics, set up distributed tracing, debug prod issues
seo-audit Audit meta tags, diagnose ranking drops, fix crawl/indexing errors, review Core Web Vitals
wcag-audit-patterns Run WCAG 2.2 accessibility audits, fix violations, implement accessible components, meet ADA/508

Let me know if you need me to add more skills from: https://skills.sh/

Summary by CodeRabbit

Release Notes

  • New Features

    • Added Docker expert skill for environment analysis, optimization, security hardening, and Compose orchestration.
    • Added Python design patterns guidance for architecture decisions.
    • Added Python observability skill for logging, metrics, and tracing.
    • Added SEO audit skill with technical, on-page, content quality, and international SEO checks.
    • Added WCAG 2.2 accessibility audit patterns with remediation guidance.
  • Documentation

    • Comprehensive reference guides and checklists for all new skills.
    • Skill versioning via lock manifest for consistency.

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds five new agent skill documents (docker-expert, python-design-patterns, python-observability, seo-audit, wcag-audit-patterns) under .agents/skills/, each with a SKILL.md entry point and reference detail files. Also adds a root AGENTS.md, a skills-lock.json manifest pinning all five skills by hash, and minor agentwatch-landing tooling updates.

Changes

Agent Skill Documents

Layer / File(s) Summary
docker-expert skill
.agents/skills/docker-expert/SKILL.md
Defines skill metadata, invocation routing workflow, container analysis procedure, validation steps, core Dockerfile/Compose expertise (multi-stage builds, security hardening, orchestration), advanced BuildKit/multi-arch patterns, a code review checklist, issue diagnostics by category, and integration/handoff guidance.
python-design-patterns skill and reference details
.agents/skills/python-design-patterns/SKILL.md, .agents/skills/python-design-patterns/references/details.md
SKILL.md covers core principles, a quick-start formatter example, troubleshooting for architectural smells, and related skill links. details.md provides worked code examples for KISS, SRP, Separation of Concerns, Composition over Inheritance, Rule of Three, Function Size, Dependency Injection, and common anti-patterns.
python-observability skill and reference details
.agents/skills/python-observability/SKILL.md, .agents/skills/python-observability/references/details.md
SKILL.md covers structlog configuration, ContextVar-based correlation ID propagation, FastAPI middleware, outbound httpx header forwarding, semantic log levels, and a best-practices summary. details.md adds Prometheus Four Golden Signals metric definitions, a track_request decorator, bounded-cardinality guidance, a timed_operation context manager, and an OpenTelemetry tracing setup with nested spans.
seo-audit skill, references, and evals
.agents/skills/seo-audit/SKILL.md, .agents/skills/seo-audit/evals/evals.json, .agents/skills/seo-audit/references/*
SKILL.md defines an audit workflow with initial assessment, technical/international/on-page/content checklists, site-type issue lists, output format, tools, and related skills. Two reference documents cover AI-writing-detection patterns and detailed international SEO evidence (hreflang, canonicalization, sitemaps, URL structure, content quality). evals.json defines 8 scenario-based test cases.
wcag-audit-patterns skill and reference details
.agents/skills/wcag-audit-patterns/SKILL.md, .agents/skills/wcag-audit-patterns/references/details.md
SKILL.md provides a WCAG 2.2 audit guide with conformance levels, POUR concepts, common violations by impact, and do/don't checklists. details.md adds a full POUR audit checklist with HTML examples, an axe-core/Playwright automated testing section, and before/after remediation patterns for labels, contrast, and keyboard navigation.

Repo Agent Wiring and Landing Tooling

Layer / File(s) Summary
Root AGENTS.md and skills-lock.json
AGENTS.md, skills-lock.json
AGENTS.md documents codebase layout, build/test commands, CI/Docker services, required environment variables, installed skills, and operational rules. skills-lock.json pins all five skills by source URL and computedHash.
agentwatch-landing Next.js docs tooling
agentwatch-landing/package.json, agentwatch-landing/AGENTS.md, agentwatch-landing/.gitignore
Adds an install-nextjs-docs npm script, inserts a generated Next.js docs path index block into the landing AGENTS.md, and adds .next-docs/ to .gitignore.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

documentation

Poem

🐇 A rabbit once hopped through the docs-filled den,
With Docker and SEO clutched tight in each pen,
"Accessibility! Patterns! Observability too!"
Skills locked and hashed, the agents all knew.
Now every AI knows just what to do,
Hop hop hooray — the AGENTS.md shines through! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title '[FEAT]: Setup agents.md file with relevant skills for the repo' accurately summarizes the main change: adding AGENTS.md and configuring five agent skills.
Linked Issues check ✅ Passed The PR fully addresses issue #231 by adding AGENTS.md documentation, configuring five relevant agent skills (docker-expert, python-design-patterns, python-observability, seo-audit, wcag-audit-patterns), standardizing agent workflow, and covering both backend/frontend components.
Out of Scope Changes check ✅ Passed All changes are within scope: AGENTS.md setup, five skill definitions with references, a skills-lock.json manifest, Next.js docs installation script, and .gitignore updates are all directly aligned with issue #231 objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

Warning

⚠️ This pull request has been flagged as potential spam (promotional) by CodeRabbit slop detection and should be reviewed carefully.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
.agents/skills/wcag-audit-patterns/SKILL.md (2)

40-58: ⚡ Quick win

Add language specification to fenced code block.

Line 40 has a fenced code block without a language specification. Specify text to enable proper syntax highlighting.

📝 Proposed fix
-```
+```text
 Critical (Blockers):
 ├── Missing alt text for functional images
 ├── No keyboard access to interactive elements
 ├── Missing form labels
 └── Auto-playing media without controls

 Serious:
 ├── Insufficient color contrast
 ├── Missing skip links
 ├── Inaccessible custom widgets
 └── Missing page titles

 Moderate:
 ├── Missing language attribute
 ├── Unclear link text
 ├── Missing landmarks
 └── Improper heading hierarchy
-```
+```
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/wcag-audit-patterns/SKILL.md around lines 40 - 58, The fenced
code block containing the WCAG audit patterns list (starting with "Critical
(Blockers):") is missing a language specification. Add `text` as the language
identifier immediately after the opening triple backticks (```) on line 40 to
enable proper syntax highlighting for the block containing the accessibility
audit severity levels and their corresponding issues.

31-36: ⚡ Quick win

Add language specification to fenced code block.

Line 31 has a fenced code block without a language specification. Specify text to enable proper syntax highlighting.

📝 Proposed fix
-```
+```text
 Perceivable:  Can users perceive the content?
 Operable:     Can users operate the interface?
 Understandable: Can users understand the content?
 Robust:       Does it work with assistive tech?
-```
+```
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/wcag-audit-patterns/SKILL.md around lines 31 - 36, The fenced
code block containing the WCAG principles (Perceivable, Operable,
Understandable, Robust) is missing a language specification. Add `text`
immediately after the opening triple backticks on the line before "Perceivable:"
to enable proper syntax highlighting in the markdown file.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/docker-expert/SKILL.md:
- Line 14: The "When invoked:" heading uses h3 markdown syntax (###) but should
use h2 syntax (##) to maintain proper heading hierarchy after the h1 title at
the top of the document. Change the heading marker from ### to ## for "When
invoked:" to ensure correct semantic structure and document navigation flow.

---

Nitpick comments:
In @.agents/skills/wcag-audit-patterns/SKILL.md:
- Around line 40-58: The fenced code block containing the WCAG audit patterns
list (starting with "Critical (Blockers):") is missing a language specification.
Add `text` as the language identifier immediately after the opening triple
backticks (```) on line 40 to enable proper syntax highlighting for the block
containing the accessibility audit severity levels and their corresponding
issues.
- Around line 31-36: The fenced code block containing the WCAG principles
(Perceivable, Operable, Understandable, Robust) is missing a language
specification. Add `text` immediately after the opening triple backticks on the
line before "Perceivable:" to enable proper syntax highlighting in the markdown
file.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4bd8d46c-3ca3-402c-8efd-cffd7518643a

📥 Commits

Reviewing files that changed from the base of the PR and between e3012c5 and 9f3b1bf.

📒 Files selected for processing (16)
  • .agents/skills/docker-expert/SKILL.md
  • .agents/skills/python-design-patterns/SKILL.md
  • .agents/skills/python-design-patterns/references/details.md
  • .agents/skills/python-observability/SKILL.md
  • .agents/skills/python-observability/references/details.md
  • .agents/skills/seo-audit/SKILL.md
  • .agents/skills/seo-audit/evals/evals.json
  • .agents/skills/seo-audit/references/ai-writing-detection.md
  • .agents/skills/seo-audit/references/international-seo.md
  • .agents/skills/wcag-audit-patterns/SKILL.md
  • .agents/skills/wcag-audit-patterns/references/details.md
  • AGENTS.md
  • agentwatch-landing/.gitignore
  • agentwatch-landing/AGENTS.md
  • agentwatch-landing/package.json
  • skills-lock.json


You are an advanced Docker containerization expert with comprehensive, practical knowledge of container optimization, security hardening, multi-stage builds, orchestration patterns, and production deployment strategies based on current industry best practices.

### When invoked:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Heading level skip from h1 to h3 (missing h2).

The "When invoked:" heading uses h3 (###) but should use h2 (##) to maintain proper hierarchy after the h1 title. This improves semantic structure and navigation.

🔧 Proposed fix
-### When invoked:
+## When invoked:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### When invoked:
## When invoked:
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 14-14: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🪛 SkillSpector (2.1.1)

[info] 63: [TM1] Tool Parameter Abuse: Tool parameters are crafted to achieve unintended or unsafe behavior. Parameter abuse can bypass intended safety checks (e.g. shell=True, --force, dangerous glob patterns).

Remediation: Validate all tool parameters against an allowlist. Reject dangerous parameter values (shell=True, --force, -rf /) and use safe defaults.

(Tool Misuse (TM1))


[warning] 247: [TM3] Unsafe Defaults: Tool defaults are unsafe or overly permissive (e.g. disabled TLS verification, no authentication, world-writable permissions). Unsafe defaults widen the attack surface.

Remediation: Override unsafe defaults with secure settings (verify=True, auth required, restrictive permissions). Review and harden all tool configurations.

(Tool Misuse (TM3))

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/docker-expert/SKILL.md at line 14, The "When invoked:"
heading uses h3 markdown syntax (###) but should use h2 syntax (##) to maintain
proper heading hierarchy after the h1 title at the top of the document. Change
the heading marker from ### to ## for "When invoked:" to ensure correct semantic
structure and document navigation flow.

Source: Linters/SAST tools

@github-actions

Copy link
Copy Markdown

🧪 PR Test Results

Check Result
Tests (pytest tests/) ❌ failure
Lint (ruff check .) ✅ success
Coverage (agentwatch) 72.70%

Python 3.12 · commit 9f3b1bf

@sreerevanth sreerevanth left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. We do use AGENTS.md workflows with agentic coding tools. Before merging, can you explain the rationale for including seo-audit and wcag-audit-patterns alongside the Python/DevOps skills? I'd like to understand how they fit AgentWatch's contributor workflow and whether we should keep only core repository skills.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] : Add Agents Setup and Documentation Sync

2 participants