Skip to content

fix: repair broken code fence and em dash in CONTRIBUTING - #210

Merged
topdaily-dev merged 1 commit into
mainfrom
fix/contributing-code-fence-and-em-dash
Aug 25, 2026
Merged

topdaily-dev merged 1 commit into
mainfrom
fix/contributing-code-fence-and-em-dash

Conversation

@topdaily-dev

Copy link
Copy Markdown
Owner

Summary

Two rendering defects in CONTRIBUTING.md:

1. Broken code fence in the "Pair programming" section. The fence markers
contained a literal n character where a newline belonged:

```nCo-authored-by: Name <id+user@users.noreply.github.com>
```n

GitHub reads nCo-authored-by:... as the fence's language identifier and never
sees a valid closing fence, so the co-author example does not render as a code
block. This is the one line a contributor is most likely to copy verbatim.

2. Mojibake in the pull request rules. Line 18 contained the byte sequence
47 C3 87 C3 B6 (GÇö) where an em dash belongs, so it read
"Keep PRs focused GÇö one logical change per PR".

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Chore / CI

Verification

Check Result
Literal ```n sequences remaining 0
Byte sequence 47 C3 87 C3 B6 remaining 0
Em dash present as E2 80 94 yes
File decodes as valid UTF-8 yes
  • npm test — all tests passing
  • Documentation only; no runtime code touched

Checklist

  • npm test passes locally
  • Tests added or updated in lib/*.test.mjs for behavior changes
  • Commit message is clear and descriptive
  • PR is focused on one logical change
  • Co-author trailers, if any, name human GitHub accounts only

Badge output

None. Badge generation is unchanged.

The co-author example used fence markers containing a literal n
character instead of a newline, so GitHub treated the trailer as a
language identifier and never closed the block. That example is the
line contributors are most likely to copy verbatim.

Line 18 also carried the byte sequence 47 C3 87 C3 B6 where an em
dash belongs, reading 'Keep PRs focused GCo one logical change per PR'.
@topdaily-dev
topdaily-dev merged commit eda59f6 into main Aug 25, 2026
1 check passed
@topdaily-dev
topdaily-dev deleted the fix/contributing-code-fence-and-em-dash branch August 25, 2026 08:59
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