Skip to content

Commit 651cbdd

Browse files
amithadCopilot
andauthored
docs: update AGENTS.md and CONTRIBUTING.md for AI agent guidance; enh… (#352)
* docs: update AGENTS.md and CONTRIBUTING.md for AI agent guidance; enhance DEVELOPER_GUIDE.md and README.md links * docs: add @lakindu-yl as a code owner in CODEOWNERS file * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent b3a9e50 commit 651cbdd

5 files changed

Lines changed: 15 additions & 14 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,15 @@ into code every adapter has to live with.
8282

8383
## Setup, build, lint, test
8484

85-
```bash
86-
make dev-setup # installs prerequisites (pyenv, tfenv, nvm/Node, Python 3.12, uv, docker) and syncs ak-py's venv (or: cd ak-py && ./build.sh)
87-
make lint-check-all # isort + black, dry-run, ak-py + examples — CI gate on every PR
88-
make lint-all # same, but writes fixes
89-
cd ak-py && uv run pytest # full test suite (coverage + html report auto-generated)
90-
```
85+
Setup steps and how to discover the full Makefile command list are canonical in
86+
[DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md) — don't re-derive or restate them here; if a command
87+
changes, update DEVELOPER_GUIDE.md and this file's pointer stays valid automatically. Two things
88+
worth knowing that aren't spelled out there:
9189

92-
Run `make lint-check-all` before considering any change to `ak-py/` or `examples/` done — it's
93-
what `code-quality.yml` runs in CI and PRs are blocked on it. Formatting is black + isort, line
94-
length 150 (`ak-py/pyproject.toml`), not the black default of 88 — don't fight the configured
95-
line length.
90+
- Formatting is black + isort at **line length 150** (`ak-py/pyproject.toml`), not black's
91+
default of 88 — don't "fix" long lines that are within the configured limit.
92+
- `make lint-check-all` is the exact command `code-quality.yml` runs in CI — run it before
93+
considering a change to `ak-py/` or `examples/` done.
9694

9795
For anything test-related beyond the basic `pytest` invocation (async fixtures, mocking
9896
frameworks/session stores, the built-in fuzzy/semantic Test framework), load
@@ -117,10 +115,9 @@ repo-wide search).
117115

118116
## Conventions
119117

120-
- **Commits**: Conventional Commits — `feat:`, `fix:`, `docs:`, `chore:`, `refactor:`, `test:`,
121-
`style:`. See recent `git log` for real examples.
122-
- **PRs**: one feature/fix per PR, tests included, docs updated when public API/config/user-facing
123-
behavior changes. Full checklist in [CONTRIBUTING.md](CONTRIBUTING.md).
118+
- **Commits & PRs**: [CONTRIBUTING.md](CONTRIBUTING.md) is canonical for commit message format
119+
(Conventional Commits) and the PR checklist — don't restate it here; follow that file, and check
120+
recent `git log` for real examples of it in practice.
124121
- **New integrations** (framework adapter, guardrail provider, knowledge base, messaging
125122
platform, multimodal storage, tracing provider) each have a dedicated step-by-step dev skill
126123
under `.agents/skills/ak-dev-new-*` — use the matching one instead of improvising the wiring,

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
* @amithad
2+
* @lakindu-yl

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ We love feature suggestions! When proposing a new feature:
137137
## Development Resources
138138

139139
- **[Developer Guide](DEVELOPER_GUIDE.md)**: Technical setup, tools, and development workflow
140+
- **[AGENTS.md](AGENTS.md)**: Guidance for AI coding agents contributing to this repo
140141
- **[README](README.md)**: Project overview and getting started
141142
- **[Documentation](docs/)**: Full documentation and examples
142143

DEVELOPER_GUIDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ Follow conventional commit format:
153153
## Additional Resources
154154

155155
- [Main README](README.md) - Project overview and usage
156+
- [AGENTS.md](AGENTS.md) - Guidance for AI coding agents contributing to this repo (architecture pointers, agent-specific gotchas)
156157
- [Documentation Setup](docs/SETUP.md) - Setting up the documentation site
157158
- [Examples](examples/) - Sample implementations
158159
- [Use Cases](use-cases/) - End-to-end agents built from `SPEC.md` using Agent Kernel skills

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,7 @@ Agent Kernel is proud to be:
212212
- 📦 **PyPI:** [`pip install agentkernel`](https://pypi.org/project/agentkernel/)
213213
- ☁️ **Terraform Registry:** [Official modules](https://registry.terraform.io/modules/yaalalabs)
214214
- 🛠 **Developer Guide:** [DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md)
215+
- 🤖 **Contributing with AI agents:** [AGENTS.md](AGENTS.md)
215216

216217
---
217218

0 commit comments

Comments
 (0)