Skip to content

Commit 4d211b3

Browse files
docs: add AGENTS.md and update SKILL.md with blog post placement convention
Agent-Logs-Url: https://github.com/feast-dev/feast/sessions/7e15980c-1caa-4596-acef-3a743989658a Co-authored-by: franciscojavierarceo <4163062+franciscojavierarceo@users.noreply.github.com>
1 parent 801030b commit 4d211b3

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Feast - Agent Instructions
2+
3+
This file provides instructions for AI coding agents (GitHub Copilot, Claude Code, OpenAI Codex, etc.) working in this repository.
4+
5+
## Project Overview
6+
7+
Feast is an open source feature store for machine learning. See `CLAUDE.md` for a full project overview and development commands.
8+
9+
## Repository Conventions
10+
11+
### Documentation and Blog Posts
12+
13+
- **Blog posts must be placed in `/infra/website/docs/blog/`** — do NOT create blog posts under `docs/blog/` or any other location.
14+
- Blog post files must include YAML frontmatter with `title`, `description`, `date`, and `authors` fields, following the format of existing posts in that directory.
15+
- All other reference documentation goes under `docs/`.
16+
17+
### Code Style
18+
19+
- Use type hints on all Python function signatures.
20+
- Follow existing patterns in the module you are modifying.
21+
- PR titles must follow semantic conventions: `feat:`, `fix:`, `ci:`, `chore:`, `docs:`.
22+
- Sign off commits with `git commit -s` (DCO requirement).
23+
24+
### Testing
25+
26+
- Run `make test-python-unit` for unit tests.
27+
- Run `make lint-python` before submitting changes.
28+
- See `skills/feast-dev/SKILL.md` for the full development guide.

skills/feast-dev/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ cd sdk/python && python -m mypy feast
7171
- Add a GitHub label to PRs (e.g. `kind/bug`, `kind/feature`, `kind/housekeeping`)
7272
- Sign off commits with `git commit -s` (DCO requirement)
7373

74+
## Documentation and Blog Posts
75+
76+
- **Blog posts must be placed in `/infra/website/docs/blog/`** — do NOT place them under `docs/blog/` or elsewhere.
77+
- Blog post files must include YAML frontmatter with `title`, `description`, `date`, and `authors` fields matching the format of existing posts in that directory.
78+
- All other reference documentation (concepts, how-tos, reference pages) goes under `docs/`.
79+
7480
## Project Structure
7581

7682
```

0 commit comments

Comments
 (0)