@@ -93,8 +93,8 @@ Architecture
9393### Build system
9494
9595 - Uses * tsdown* for cross-platform builds (Deno -> Node.js/npm)
96- - Generates ESM (* dist/ * .js * ) and CommonJS (* dist/ * .cjs * ) outputs
97- - Creates TypeScript definitions for both (* dist/ * .d.ts * , * dist/ * .d.cts * )
96+ - Generates ESM (_ dist/ \* .js _ ) and CommonJS (_ dist/ \* .cjs _ ) outputs
97+ - Creates TypeScript definitions for both (_ dist/ \ * .d.ts _ , _ dist/ \ * .d.cts _ )
9898 - Includes Temporal polyfill injection for Node.js compatibility
9999
100100### Dual runtime support
@@ -130,22 +130,25 @@ and Node.js compatibility.
130130
131131### When making changes
132132
133- 1 . Run ` deno task check ` before committing to validate all aspects
134- 2 . The build process (* tsdown* ) generates dual outputs for both runtimes
135- 3 . Tests should work in both Deno and Node.js environments
136- 4 . * Update documentation* : New features must be documented in the * docs/*
133+ 1 . Run ` deno task check ` before committing to validate all aspects
134+ 2 . The build process (* tsdown* ) generates dual outputs for both runtimes
135+ 3 . Tests should work in both Deno and Node.js environments
136+ 4 . * Update documentation* : New features must be documented in the * docs/*
137137 directory
138- 5 . * Update changelog* : Any user-facing changes must be recorded in
138+ 5 . * Update changelog* : Any user-facing changes must be recorded in
139139 * CHANGES.md*
140140
141141### Commit messages
142142
143143 - Do not use Conventional Commits (no ` fix: ` , ` feat: ` , etc. prefixes).
144144 Keep the first line under 50 characters when possible.
145+
145146 - Focus on * why* the change was made, not just * what* changed.
147+
146148 - When referencing issues or PRs, use permalink URLs instead of just
147149 numbers (e.g., ` #123 ` ). This preserves context if the repository
148150 is moved later.
151+
149152 - When listing items after a colon, add a blank line after the colon:
150153
151154 ~~~~
@@ -249,6 +252,7 @@ Code style
249252
250253 - All exported APIs must have JSDoc comments describing their purpose,
251254 parameters, and return values.
255+
252256 - For APIs added in a specific version, include the `@since` tag with the
253257 version number:
254258
@@ -329,8 +333,8 @@ Code style
329333
330334### Log messages
331335
332- - This project uses [LogTape] for logging. Refer to the [LogTape LLM
333- documentation] for detailed usage.
336+ - This project uses [LogTape] for logging. Refer to the
337+ [LogTape LLM documentation] for detailed usage.
334338
335339 - Use [structured logging] with LogTape instead of string interpolation:
336340
@@ -429,7 +433,9 @@ documentation:
429433### Lists
430434
431435 - Use ` - ` (space-hyphen-two spaces) for unordered list items
436+
432437 - Indent nested items with 4 spaces
438+
433439 - Align continuation text with the item content:
434440
435441 ~~~~
@@ -441,6 +447,7 @@ documentation:
441447### Code blocks
442448
443449 - Use four tildes (`~~~~`) for code fences instead of backticks
450+
444451 - Always specify the language identifier:
445452
446453 ~~~~~
@@ -461,6 +468,7 @@ documentation:
461468
462469 - Use reference-style links placed at the *end of each section*
463470 (not at document end)
471+
464472 - Format reference links with consistent spacing:
465473
466474 ~~~~
0 commit comments