-
Notifications
You must be signed in to change notification settings - Fork 13
refactor: restructure the exercise-finished README template #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the exercise-finished.md
template to improve layout, update headings and badges, add a “What’s Next?” section, and include a footer.
- Wrapped content in a centered
<div>
and adjusted image sizes - Revised headings and badges for consistency and added a GitHub Skills link
- Added a footer with copyright and code of conduct/license links
|
||
> [!TIP] | ||
> Mona won't grade you this time! 😉 | ||
### 🌟 You've successfully completed the exercise! 🌟 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Use consistent heading levels: consider changing this ###
to ##
so that all major sections under the H1 are H2 for clearer structure.
### 🌟 You've successfully completed the exercise! 🌟 | |
## 🌟 You've successfully completed the exercise! 🌟 |
Copilot uses AI. Check for mistakes.
--- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] There are two horizontal rules (----
at line 17 and ---
here). Consider consolidating to a single separator to avoid redundant markup.
--- |
Copilot uses AI. Check for mistakes.
|
||
If you would like to retrace your steps, you can always revisit the exercise. | ||
<img src="https://octodex.github.com/images/welcometocat.png" height="200px" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add an alt
attribute to this image for better accessibility, e.g., alt="Welcome Octocat illustration"
.
<img src="https://octodex.github.com/images/welcometocat.png" height="200px" /> | |
<img src="https://octodex.github.com/images/welcometocat.png" height="200px" alt="Welcome Octocat illustration" /> |
Copilot uses AI. Check for mistakes.
|
||
Let's keep the momentum going! Head over to [GitHub Skills](https://skills.github.com) catalog to find another hands-on exercise. :rocket: | ||
© 2025 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Hardcoding the year may require future updates; consider using a dynamic placeholder (e.g., {{ current_year }}
) to keep this up to date automatically.
© 2025 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) | |
© {{ current_year }} GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) |
Copilot uses AI. Check for mistakes.
Changes
Checklist