From 6ecac82c63a2cf9ee9affe407fad3acf74f2f2f2 Mon Sep 17 00:00:00 2001 From: Pat Whittingslow Date: Thu, 30 Jul 2026 18:50:05 -0300 Subject: [PATCH 1/3] Add agents.md guideline for using ASD-STE100 in documentation --- agents.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 agents.md diff --git a/agents.md b/agents.md new file mode 100644 index 0000000000..96bfbf1477 --- /dev/null +++ b/agents.md @@ -0,0 +1 @@ +Use ASD-STE100 Simplified Technical English for content outside of the code like comments, PR description, PR title, github comments. From 1cb04578a31c7817e01c4f786bb179190d31f252 Mon Sep 17 00:00:00 2001 From: Pat Whittingslow Date: Fri, 28 Aug 2026 10:07:14 -0300 Subject: [PATCH 2/3] @deadprogram success story --- agents.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/agents.md b/agents.md index 96bfbf1477..0257acf002 100644 --- a/agents.md +++ b/agents.md @@ -1 +1,10 @@ -Use ASD-STE100 Simplified Technical English for content outside of the code like comments, PR description, PR title, github comments. +## 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. From 1c2901f20612f31d0abcffaafc9ed352b3be0f3e Mon Sep 17 00:00:00 2001 From: Pat Whittingslow Date: Fri, 28 Aug 2026 10:08:12 -0300 Subject: [PATCH 3/3] Rename agents.md to AGENTS.md --- agents.md => AGENTS.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename agents.md => AGENTS.md (100%) diff --git a/agents.md b/AGENTS.md similarity index 100% rename from agents.md rename to AGENTS.md