Skip to content

docs: Add writing and code comment guidance - #107

Merged
jiahuei merged 1 commit into
mainfrom
docs/writing-and-code-comment-guidance
Nov 18, 2026
Merged

jiahuei merged 1 commit into
mainfrom
docs/writing-and-code-comment-guidance

Conversation

@jiahuei

@jiahuei jiahuei commented Nov 18, 2026

Copy link
Copy Markdown
Member

Summary

  • Added ASD-STE100 principles for agent writing and guidance on how to explain and wrap code comments. The password-reset example shows how to name the relevant value and explain the consequence of a race. TokenVisor #883

Verification

  • Checked the updated guide with npx --yes prettier@3.8 --check AGENTS.md and checked the patch with git diff --no-index --check original AGENTS.md. Both checks passed.
  • Application tests were skipped because the change only updates documentation.

@github-actions

Copy link
Copy Markdown

Coverage

Coverage Report (Python 3.14) •
FileStmtsMissCoverMissing
TOTAL358319595% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
2614 0 💤 0 ❌ 0 🔥 37.695s ⏱️

@github-actions

Copy link
Copy Markdown

Coverage

Coverage Report (Python 3.12) •
FileStmtsMissCoverMissing
TOTAL362919595% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
2614 0 💤 0 ❌ 0 🔥 57.119s ⏱️

@github-actions

Copy link
Copy Markdown

Coverage

Coverage Report (Python 3.13) •
FileStmtsMissCoverMissing
TOTAL362919595% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
2614 0 💤 0 ❌ 0 🔥 1m 4s ⏱️

@jiahuei
jiahuei merged commit b1dfeaa into main Nov 18, 2026
5 checks passed
@jiahuei
jiahuei deleted the docs/writing-and-code-comment-guidance branch November 18, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant