Skip to content

Conversation

@mao-sz
Copy link
Contributor

@mao-sz mao-sz commented Jan 15, 2024

Because

People are very commonly concerned when they see their exercise solutions differ from the provided solutions. This is primarily from two parts:

  • Learners are initially directed straight to the relevant exercise directory and not told to read the repo README (where a note about the provided solution is). This has been addressed in #27055
  • The README note on provided solutions, despite saying the provided one isn't the only solution, the rest of the sentence seems to be interpret-able as "if your solution differs, check with the community if it's actually allowed".

This PR

  • Improves the wording of the relevant README note to clarify intent (unified wording with javascript-exercises repo)

Issue

Closes #27053

Additional Information

In conjunction with #424 from the css-exercises repo

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the location of change: brief description of change format, e.g. 01-flex-center: Update self check
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If applicable, I have ensured that the TOP solution files match the Desired Outcome image

Same change made in parallel with the javascript-exercises repo to unify
wording.
As per markdown style guide, now uses lazy numbering, dashes for
unordered lists and 3-space indents when nested in an ordered list.
@mao-sz
Copy link
Contributor Author

mao-sz commented Jan 19, 2024

Wording changes made as per TheOdinProject/javascript-exercises#424 (comment)

@thatblindgeye thatblindgeye merged commit b7c0fd9 into TheOdinProject:main Jan 19, 2024
@mao-sz mao-sz deleted the chore/improve-readme-wording-on-provided-solution branch January 19, 2024 18:07
AngryBabushka pushed a commit to AngryBabushka/css-exercises that referenced this pull request Feb 23, 2024
…readme-wording-on-provided-solution

Repo README: Improve wording regarding TOP provided solution
TeamPlatinum1 pushed a commit to TeamPlatinum1/css-exercises that referenced this pull request Sep 3, 2024
…readme-wording-on-provided-solution

Repo README: Improve wording regarding TOP provided solution
Oussama5379 added a commit to Oussama5379/css-exercises that referenced this pull request Feb 1, 2025
…readme-wording-on-provided-solution

Repo README: Improve wording regarding TOP provided solution
repo-jr added a commit to repo-jr/css-exercises that referenced this pull request Aug 29, 2025
…readme-wording-on-provided-solution

Repo README: Improve wording regarding TOP provided solution
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.

Foundations: Be more explicit about exercise solutions not being the only solutions

2 participants