mirror of
https://github.com/tinygo-org/tinygo.git
synced 2026-08-31 17:59:03 +00:00
Pat Whittingslow
f924a9e3ea
* Add agents.md guideline for using ASD-STE100 in documentation * @deadprogram success story * Rename agents.md to AGENTS.md
11 lines
810 B
Markdown
11 lines
810 B
Markdown
## 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.
|