Repo README: Improve wording regarding TOP provided solution - #424
Conversation
Same change made in parallel with the css-exercises repo to unify wording.
| 5. Once you successfully finish an exercise, check the `solutions` directory within each exercise to compare it with yours. | ||
| - You should not be checking the solution for an exercise until you finish it! | ||
| - Keep in mind that TOP's solution is not the only solution. Generally as long as all of the tests pass, your solution should be fine. | ||
| - If your solution differs wildly from TOP's solution (and still passes the self-check criteria), that's completely fine. Do feel free to ask about it in the chatroom if there are parts you do not understand. |
There was a problem hiding this comment.
I feel like we need to note that the solution ideally should be in line with the concepts that were learned leading up to doing the exercise. For example, if an exercise is assigned after learning about string methods, ideally a user's solution should use string methods (vs loops). That may be a larger conversation/re-evaluating where each exercise is introduced within the context of the curriculum.
Unless you feel adding some verbiage like that would be helpful right now, I only have one nit below:
| - If your solution differs wildly from TOP's solution (and still passes the self-check criteria), that's completely fine. Do feel free to ask about it in the chatroom if there are parts you do not understand. | |
| - If your solution differs wildly from TOP's solution (and still passes the self-check criteria), that's completely fine. Do feel free to ask about it in our Discord if there are parts you do not understand. |
There was a problem hiding this comment.
My feeling at the moment is that "meeting the exercise requirements" should be sufficient to imply that, depending on what the exercise requirements are. And that if there is an intention for an exercise to be done a certain way based on recent lesson content, then that would be better placed in the relevant exercise's requirements. Thoughts?
For now I'll make that nit change and also rephrase "self-check criteria" to "exercise's requirements", as there technically isn't a "self-check criteria" section in the exercises' READMEs.
…readme-wording-on-provided-solution Repo README: Improve wording regarding TOP provided solution
…readme-wording-on-provided-solution Repo README: Improve wording regarding TOP provided solution
…readme-wording-on-provided-solution Repo README: Improve wording regarding TOP provided solution
…readme-wording-on-provided-solution Repo README: Improve wording regarding TOP provided solution
…readme-wording-on-provided-solution Repo README: Improve wording regarding TOP provided solution
Because
People are very commonly concerned when they see their exercise solutions differ from the provided solutions. This is primarily from two parts:
This PR
css-exercisesrepo)Issue
Closes #27053
Additional Information
In conjunction with #463 from the
css-exercisesrepoPull Request Requirements
location of change: brief description of changeformat, e.g.01-flex-center: Update self checkBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection