Skip to content

docs(SD-000): add AI-support context (CLAUDE.md, README, AGENTS) - #70

Merged
salkhwlani merged 2 commits into
masterfrom
feature/SD-000-ai-context-docs
Aug 3, 2026
Merged

docs(SD-000): add AI-support context (CLAUDE.md, README, AGENTS)#70
salkhwlani merged 2 commits into
masterfrom
feature/SD-000-ai-context-docs

Conversation

@maqalaqil

@maqalaqil maqalaqil commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What kind of change does this PR introduce?

  • docs

What is the current behaviour?

  • The repo lacks structured AI-support context for AI tools (Claude Code, Greptile, Codex) and new contributors.

What is the new behaviour?

  • Adds three repo-specific files — CLAUDE.md (agent guide), a refreshed README, and AGENTS.md — describing purpose, stack, run/test commands, architecture, cross-repo dependencies, and gotchas.
  • Part of the coordinated AI-context-docs rollout; all sibling PRs share Jira SD-000 and branch feature/SD-000-ai-context-docs.
  • https://salla.atlassian.net/browse/SD-000

Does this PR introduce a breaking change?

  • No. Documentation only — no source or behavior changes.

Depends on PRs:

  • -

Greptile Summary

Adds repository-specific guidance for AI assistants and contributors, while refreshing testing and contribution instructions in the README.

  • Introduces concise and detailed agent guides in AGENTS.md and CLAUDE.md.
  • Documents the package architecture, dependencies, public API considerations, ZATCA-specific gotchas, and cross-repository consumers.
  • Clarifies Composer-based testing and separates internal from external contribution guidance.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

The new agent guidance and README updates align with the repository’s Composer configuration and principal source behavior, with no changed-code-triggered failure or actionable documentation defect identified.

Important Files Changed

Filename Overview
AGENTS.md Adds a concise entry point directing agents to the full guide and highlighting core repository constraints.
CLAUDE.md Adds detailed, source-aligned documentation covering the stack, architecture, workflows, dependencies, and implementation gotchas.
README.md Clarifies test setup and introduces internal contribution conventions without changing runtime behavior.

Reviews (1): Last reviewed commit: "docs: remove greptile.json" | Re-trigger Greptile

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: run a review on demand. To trigger the first review automatically, go to your organization or repository integration settings. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@maqalaqil maqalaqil changed the title docs(SD-000): add AI-support context (CLAUDE.md, README, AGENTS, greptile) docs(SD-000): add AI-support context (CLAUDE.md, README, AGENTS) Jun 29, 2026
@salkhwlani
salkhwlani marked this pull request as ready for review August 3, 2026 11:16
@salkhwlani
salkhwlani requested a review from a team as a code owner August 3, 2026 11:16
@salkhwlani
salkhwlani merged commit da58fb7 into master Aug 3, 2026
2 checks passed
@salkhwlani
salkhwlani deleted the feature/SD-000-ai-context-docs branch August 3, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants