Skip to content

Commit 2c0bfc4

Browse files
Update SKILL.md
1 parent 3a35920 commit 2c0bfc4

1 file changed

Lines changed: 12 additions & 36 deletions

File tree

plugins/core/skills/init/SKILL.md

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,19 @@ description: Initialize a new repository with AGENTS.md
55
disable-model-invocation: true
66
---
77

8-
Generate a file named AGENTS.md that serves as a contributor guide for this repository.
9-
Your goal is to produce a clear, concise, and well-structured document with descriptive headings and actionable explanations for each section.
10-
Follow the outline below, but adapt as needed — add sections if relevant, and omit those that do not apply to this project.
8+
Please analyze this codebase and create a AGENTS.md file, which will be given to future instances of Droid to operate in this repository.
119

12-
Document Requirements
10+
What to add:
1311

14-
- Title the document "Repository Guidelines".
15-
- Use Markdown headings (#, ##, etc.) for structure.
16-
- Keep the document concise. 200-400 words is optimal.
17-
- Keep explanations short, direct, and specific to this repository.
18-
- Provide examples where helpful (commands, directory paths, naming patterns).
19-
- Maintain a professional, instructional tone.
12+
1. Commands that will be commonly used, such as how to build, lint, and run tests. Include the necessary commands to develop in this codebase, such as how to run a single test.
13+
2. High-level code architecture and structure so that future instances can be productive more quickly. Focus on the "big picture" architecture that requires reading multiple files to understand.
2014

21-
Recommended Sections
15+
Usage notes:
2216

23-
Project Structure & Module Organization
24-
25-
- Outline the project structure, including where the source code, tests, and assets are located.
26-
27-
Build, Test, and Development Commands
28-
29-
- List key commands for building, testing, and running locally (e.g., npm test, make build).
30-
- Briefly explain what each command does.
31-
32-
Coding Style & Naming Conventions
33-
34-
- Specify indentation rules, language-specific style preferences, and naming patterns.
35-
- Include any formatting or linting tools used.
36-
37-
Testing Guidelines
38-
39-
- Identify testing frameworks and coverage requirements.
40-
- State test naming conventions and how to run tests.
41-
42-
Commit & Pull Request Guidelines
43-
44-
- Summarize commit message conventions found in the project’s Git history.
45-
- Outline pull request requirements (descriptions, linked issues, screenshots, etc.).
46-
47-
(Optional) Add other sections if relevant, such as Security & Configuration Tips, Architecture Overview, or Agent-Specific Instructions.
17+
- After analyzing the codebase, if no AGENTS.md exists, create it directly. If an AGENTS.md already exists, show the proposed new contents and ask for confirmation before modifying the file.
18+
- When you make the initial AGENTS.md, do not repeat yourself and do not include obvious instructions like "Provide helpful error messages to users", "Write unit tests for all new utilities", "Never include sensitive information (API keys, tokens) in code or commits".
19+
- Avoid listing every component or file structure that can be easily discovered.
20+
- Don't include generic development practices.
21+
- If there are Cursor rules (in .cursor/rules/ or .cursorrules), Copilot rules (in .github/copilot-instructions.md), or CLAUDE.md files, make sure to include the important parts.
22+
- If there is a README.md, make sure to include the important parts.
23+
- Do not make up information such as "Common Development Tasks", "Tips for Development", "Support and Documentation" unless this is expressly included in other files that you read.

0 commit comments

Comments
 (0)