2.3. Markdown for Clear Communication
Every issue, pull request comment, and README on GitHub is written in the same lightweight formatting language, and knowing its GitHub-specific extensions is worth exam points on its own.
💡 First Principle: Markdown lets you add structure — headings, lists, code, links — to plain text using plain-text symbols, so formatted content stays readable even in its raw, unrendered form. GitHub renders standard Markdown everywhere text can be entered, and adds its own extensions — collectively called GitHub Flavored Markdown (GFM) — that only work inside GitHub.
| GFM Feature | Syntax | Renders As |
|---|---|---|
| Task list | - [ ] Task | An interactive checkbox |
| Autolinked issue/PR | #42 | A clickable link to issue or PR 42 |
| User mention | @username | A clickable profile link + notification |
| Emoji shortcode | :tada: | 🎉 |
| Syntax-highlighted code | Three backticks + a language name (e.g. python) | Colorized code block |
Task lists are especially exam-relevant: checking one off in an issue or PR description updates a visible completion count wherever that issue is referenced, including on a linked Projects board.
⚠️ Exam Trap: GitHub Flavored Markdown is not identical to standard Markdown. Features like task lists, @mentions, and #issue autolinking are GitHub-specific extensions that won't render the same way in a plain Markdown file opened outside GitHub.
Reflection Question: If you write - [ ] Write tests in an issue description, what does that syntax give you that a plain bullet point wouldn't?
