Skip to content

Commit ec9dd12

Browse files
committed
init message tweaks
1 parent 789a6c7 commit ec9dd12

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

src/browser/assets/initMessage.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Recommended sections:
2222
- test
2323
- clean
2424
- development server
25+
- other *important* scripts (use `find -type f -name '*.sh'` or similar)
2526
- Patterns (optional)
2627
- List any important or uncommon patterns (compared to other similar codebases), with examples (e.g., how to authorize an HTTP request).
2728
- List any important workflows and their steps (e.g., how to make a database migration).
@@ -37,12 +38,8 @@ You can add other sections if they are necessary.
3738
If the information required for mandatory sections isn't available due to the workspace being empty or sparse, add TODO text in its place.
3839
Optional sections should be scrapped if the information is too thin.
3940

40-
You can find some examples of AGENTS.md files online that you can use for inspiration if you have access. DO NOT COPY THESE VERBATIM.
41-
- https://raw.githubusercontent.com/coder/coder/refs/heads/main/AGENTS.md
42-
- https://raw.githubusercontent.com/coder/mux/refs/heads/main/docs/AGENTS.md
43-
4441
Above all things:
45-
- The document must be clear and concise. Less than 400 words is optimal. Measure the word count of the complete file and strive to achieve this goal without losing important information.
42+
- The document must be clear and concise. Simple projects should need less than 400 words, but larger and more mature codebases will likely need 700+. Prioritize completeness over brevity.
4643
- Don't include useless fluff.
4744
- The document must be in Markdown format and use headings for structure.
4845
- Give examples where necessary or helpful (commands, directory paths, naming patterns).

0 commit comments

Comments
 (0)