fix(*): add extra blank line before the first entry in list#1
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates handbook Markdown formatting to ensure lists render correctly by inserting an extra blank line before the first list item in many sections across student, maintainer, appendix docs, and templates.
Changes:
- Inserted blank lines before checklist/bulleted/numbered lists following paragraphs, headings, and code blocks across multiple docs.
- Updated the release checklist template and various handbook chapters to follow the same spacing pattern for consistent rendering.
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/templates/release-checklist.md | Adds a blank line before the tagging checklist resumes after a fenced code block. |
| docs/student/18-exercises.md | Adds blank lines before multiple lists in the exercise instructions. |
| docs/student/16-faq.md | Adds a blank line before a numbered item following a wrapped paragraph. |
| docs/student/13-merge-conflicts.md | Adds blank lines before bulleted lists in conflict-resolution steps. |
| docs/student/12-reviews.md | Adds blank lines before checklist sections and etiquette bullet lists. |
| docs/student/11-pull-requests.md | Adds blank lines before lists in the PR template example and guidelines. |
| docs/student/10-push.md | Adds a blank line before the force-push rules list. |
| docs/student/09-commits.md | Adds blank lines before rules lists in commit message guidance. |
| docs/student/08-branches.md | Adds blank lines before lists and within an output example section. |
| docs/student/07-daily-workflow.md | Adds blank lines between paragraphs and numbered list entries. |
| docs/student/05-ssh.md | Adds blank lines before bulleted lists in SSH guidance and pitfalls. |
| docs/student/04-initial-setup.md | Adds blank lines between numbered “common mistakes” items. |
| docs/student/03-workflow-overview.md | Adds blank lines between numbered “common mistakes” items. |
| docs/student/02-git-vs-github.md | Adds blank lines between top-level bullet items and list sections. |
| docs/student/01-introduction.md | Adds blank lines between numbered “situations” and “mistakes” items. |
| docs/maintainer/19-student-offboarding.md | Adds blank lines before checklist sections and bullet lists. |
| docs/maintainer/18-student-onboarding.md | Adds a blank line before the bullet list in PR review guidance. |
| docs/maintainer/16-archiving.md | Adds blank lines before bulleted lists in archiving guidance. |
| docs/maintainer/15-backup-strategy.md | Adds blank lines before bullet lists and storage guidance lists. |
| docs/maintainer/14-ci-preparation.md | Adds blank lines around list sections and within example workflow snippets. |
| docs/maintainer/13-testing-policy.md | Adds blank lines before required/not-required test lists and examples. |
| docs/maintainer/12-documentation-policy.md | Adds blank lines before documentation requirement bullet lists. |
| docs/maintainer/10-releases.md | Adds blank lines before release component lists and release note sections. |
| docs/maintainer/09-merge-strategy.md | Adds a blank line before the merge-message rules list. |
| docs/maintainer/08-review-workflow.md | Adds blank lines before bulleted steps and checklist-like sections. |
| docs/maintainer/07-project-board.md | Adds blank lines before bullet lists describing board usage. |
| docs/maintainer/06-milestones.md | Adds blank lines before bullet lists describing milestone usage. |
| docs/maintainer/05-labels.md | Adds blank lines before label-usage bullet list sections. |
| docs/maintainer/04-collaborators.md | Adds blank lines before verification bullet lists. |
| docs/maintainer/03-branch-protection.md | Adds blank lines before sub-option bullet lists. |
| docs/maintainer/01-repo-creation.md | Adds blank lines before short confirmation bullet lists. |
| docs/appendices/research-software-principles.md | Adds blank lines before principle consequence/application lists. |
| docs/appendices/group-policies.md | Adds blank lines before required-files and policy PR requirement lists. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Need extra blank line before list to make it correctly rendered
Summary of Changes
Add necessary blank line before list
Files Affected
Testing Performed
Screenshots
Related Issue
Closes #
Checklist
python -m pytest)main