Skip to content

Commit 32d269d

Browse files
SimonWallnerclaude
andcommitted
Add agent/contributor guide pointing to docs guidelines
Adds AGENTS.md (with CLAUDE.md importing it) so agents and new contributors are made aware that documented contribution guidelines exist, and to follow them. The file deliberately holds no rules itself — the live Notion guide is the single source of truth so it can't go stale. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent c9d80db commit 32d269d

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# LocalStack Docs — Agent Guide
2+
3+
This repo has documented contribution guidelines. They can change over time, so the
4+
**single source of truth is the live Notion page — never a copy.** This file
5+
deliberately contains none of the actual rules; it only points you to them.
6+
7+
**Guidelines:** Guide: LocalStack Docs Workflows & Management
8+
https://www.notion.so/localstack/Guide-LocalStack-Docs-Workflows-Management-1d1fc2a234318044b044fc6554fcc9e4
9+
10+
## What the agent should do
11+
12+
1. **Load the guidelines.** When a session will create or change docs, fetch the
13+
Notion page above and follow it throughout the work.
14+
15+
2. **Tell the user, lightly.** Once per session, let them know the guidelines exist
16+
— don't recite them:
17+
18+
> 📌 Heads up: contributing to these docs follows LocalStack's guidelines. I'll
19+
> read them and follow them for you. Full guide: <Notion link>
20+
21+
Non-blocking, once per session. If the user says they know the process, drop it.
22+
23+
3. **At wrap-up, apply them.** Before the work is finalized (e.g. opening a PR),
24+
re-check the guidelines and make sure the change complies.
25+
26+
## If you can't access Notion
27+
28+
If you can't fetch the page in this session, don't guess. Tell the user and offer
29+
two paths — preferred first:
30+
31+
- **Preferred:** ask them to give you Notion access so you can read and follow it.
32+
- **Fallback:** give them the link and ask them to read it and own compliance.
33+
At that point your part is done.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)