tinygo-org/tinygo
1
0
Fork 0
mirror of https://github.com/tinygo-org/tinygo.git synced 2026-08-30 01:09:02 +00:00
Code Issues Packages Projects Releases 6 Wiki Activity

Add agents.md guideline for using ASD-STE100 in documentation and discourse (#5566)

Browse Source 
* Add agents.md guideline for using ASD-STE100 in documentation

* @deadprogram success story

* Rename agents.md to AGENTS.md
This commit is contained in:
Pat Whittingslow
2026-08-28 12:42:58 -03:00
committed by GitHub
parent b9577ac8aa
commit f924a9e3ea
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+10
View File
@@ -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.