Skip to content

Update making-the-grade instructions and hints to remove extra step.#953

Merged
vaeng merged 1 commit into
exercism:mainfrom
Sencudra:fix_making_the_grade_docs
May 6, 2025
Merged

Update making-the-grade instructions and hints to remove extra step.#953
vaeng merged 1 commit into
exercism:mainfrom
Sencudra:fix_making_the_grade_docs

Conversation

@Sencudra

Copy link
Copy Markdown
Contributor

What is the problem?

While the instructions section contains only 5 steps described in the instructions.md file, 6 steps are visible on the web.

Solution

Quick fix is to move 'How to calculate the intervals' to hints.md.

@github-actions

Copy link
Copy Markdown
Contributor

Hello. Thanks for opening a PR on Exercism 🙂

We ask that all changes to Exercism are discussed on our Community Forum before being opened on GitHub. To enforce this, we automatically close all PRs that are submitted. That doesn't mean your PR is rejected but that we want the initial discussion about it to happen on our forum where a wide range of key contributors across the Exercism ecosystem can weigh in.

You can use this link to copy this into a new topic on the forum. If we decide the PR is appropriate, we'll reopen it and continue with it, so please don't delete your local branch.

If you're interested in learning more about this auto-responder, please read this blog post.


Note: If this PR has been pre-approved, please link back to this PR on the forum thread and a maintainer or staff member will reopen it.

@github-actions github-actions Bot closed this Mar 24, 2025
@Sencudra

Copy link
Copy Markdown
Contributor Author

@vaeng vaeng reopened this Mar 24, 2025

@vaeng vaeng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@vaeng vaeng merged commit ed023da into exercism:main May 6, 2025
@superherointj

Copy link
Copy Markdown

IMHO a hint shouldn't be for the problem description.

@Sencudra Sencudra deleted the fix_making_the_grade_docs branch June 4, 2025 16:50
@Sencudra

Sencudra commented Jun 4, 2025

Copy link
Copy Markdown
Contributor Author

@superherointj

  1. This PR is about fixing description / UI desyncrhonization. It's not about hints content.
  2. Any insights why you actually think there should be no hints? Are there any guidelines for this?

@superherointj

superherointj commented Jun 4, 2025

Copy link
Copy Markdown
1. This PR is about fixing description / UI desyncrhonization. It's not about hints content.

But content was moved from instructions.md to hints.md, right?

Instructions without any interval information makes the problem statement unclear.

2. Any insights why you actually think there should be no hints? Are there any guidelines for this?

I don't think having hints is a problem. Just that the problem statement is unclear without the interval information.

I have already solved the problem, so I no longer care. Only provided feedback since others may find it useful. Or else they'll likely get stuck until they read hints.

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.

3 participants