Skip to content

Commit e8faab0

Browse files
committed
docs: add instructions to use ASD-STE-100 Simplified Technical English like other TinyGo repos
Signed-off-by: deadprogram <ron@hybridgroup.com>
1 parent 6791c13 commit e8faab0

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Communication style
2+
Use ASD-STE-100 Simplified Technical English when you speak to the operator.
3+
4+
## Comments
5+
Use ASD-STE100 Simplified Technical English for content outside of the code like comments, PR description, PR title, github comments, and issues.
6+
7+
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.
8+
9+
## No coding tool attributions
10+
Never add "created by XXX" or any other attributions from coding tools to any PRs, issues, comments, or anywhere else.

0 commit comments

Comments
 (0)