Skip to content

Commit a14016c

Browse files
jdorfmanampcode-com
andcommitted
Add AGENTS.md for better agent guidance
Co-authored-by: Amp <[email protected]> Amp-Thread-ID: https://ampcode.com/threads/T-61f82727-01d4-4d68-9680-76d794a3c2ea
1 parent 81cf195 commit a14016c

File tree

2 files changed

+31
-30
lines changed

2 files changed

+31
-30
lines changed

AGENT.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

AGENT.md

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

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Agent Guidelines for awesome-amp-cli Repository
2+
3+
## Build, Lint & Test Commands
4+
5+
- Lint readme: `npx awesome-lint readme.md`
6+
- Link check: `awesome_bot --allow-redirect --white-list https://github.com/jdorfman/awesome-amp-code,https://example.com readme.md`
7+
- Node.js version: Use v21.6.0 (as specified in .tool-versions)
8+
9+
## Code Style Guidelines
10+
11+
- **Markdown Format**: Follow standard Markdown formatting for documentation
12+
- **List Items**: Add items at the bottom of existing lists
13+
- **Item Format**: `- [item name](https link) - Description beginning with capital, ending in period.`
14+
- **Commits**: Always create a new branch for proposed changes
15+
- **PR Process**: Check spelling and grammar before submitting
16+
- **Code of Conduct**: All contributions must adhere to the Code of Conduct
17+
18+
## Project Structure
19+
20+
- Documentation is the primary focus of this repository
21+
- Main content is in amp_cli_docs.md and readme.md
22+
- CI pipeline uses awesome-lint and awesome_bot to validate content
23+
24+
## Add link to Built With section
25+
26+
When `/builtwith` followed by a link is included in a prompt, you will add the link to the Built With section of the README.md file. If there is a numbered list of urls, create subagents to complete the tasks.
27+
28+
## Add link to @docs/amp_faq.md
29+
30+
When `/faq` followed by a link is included in a prompt, you will add the link to the @docs/amp_faq.md file in between `---` and `---` Place it above the last question. The update the Last Modified date

0 commit comments

Comments
 (0)