From f924a9e3ea19d8fbb5295c01875f9f30b1b9d12c Mon Sep 17 00:00:00 2001 From: Pat Whittingslow Date: Fri, 28 Aug 2026 12:42:58 -0300 Subject: [PATCH] Add agents.md guideline for using ASD-STE100 in documentation and discourse (#5566) * Add agents.md guideline for using ASD-STE100 in documentation * @deadprogram success story * Rename agents.md to AGENTS.md --- AGENTS.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..0257acf00 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,10 @@ +## Communication style +Use ASD-STE-100 Simplified Technical English when you speak to the operator. + +## Comments +Use ASD-STE100 Simplified Technical English for content outside of the code like comments, PR description, PR title, github comments, and issues. + +Generally omit extra redundant comments. If a comment is absolutely needed, always keep it brief, no more than 2 lines. Avoid extra use of colons, semicolons, and dashes. When comments are required due to some specific requirements, include a reference such as to a datasheet or other definitive source to explain why this is the case, including the chapter/section number, page number, and/or URL. + +## No coding tool attributions +Never add "created by XXX" or any other attributions from coding tools to any PRs, issues, comments, or anywhere else.