Skip to content

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

Merged
merged 1 commit into from
Jun 5, 2025

Conversation

FidelusAleksander
Copy link
Contributor

Changes

Checklist

  • I have added or updated appropriate labels to this PR
  • I have tested my changes
  • I have updated the documentation if needed

@Copilot Copilot AI review requested due to automatic review settings June 5, 2025 15:21
@github-actions github-actions bot added the templates Changes to the markdown templates label Jun 5, 2025
@FidelusAleksander FidelusAleksander merged commit 0076dae into main Jun 5, 2025
6 checks passed
@FidelusAleksander FidelusAleksander deleted the update-readme-templ branch June 5, 2025 15:23
Copy link
Contributor

@Copilot Copilot AI left a 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! 🌟
Copy link
Preview

Copilot AI Jun 5, 2025

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.

Suggested change
### 🌟 You've successfully completed the exercise! 🌟
## 🌟 You've successfully completed the exercise! 🌟

Copilot uses AI. Check for mistakes.

Comment on lines +28 to 29
---

Copy link
Preview

Copilot AI Jun 5, 2025

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.

Suggested change
---

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" />
Copy link
Preview

Copilot AI Jun 5, 2025

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".

Suggested change
<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:
&copy; 2025 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
Copy link
Preview

Copilot AI Jun 5, 2025

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.

Suggested change
&copy; 2025 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
&copy; {{ current_year }} GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
templates Changes to the markdown templates
Development

Successfully merging this pull request may close these issues.

2 participants