Skip to content
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

Reframe collatz-conjecture exercise instructions as a story #2508

Merged
merged 6 commits into from
Dec 10, 2024

Conversation

tasxatzial
Copy link
Member

Forum thread

https://forum.exercism.org/t/a-story-for-the-collatz-conjecture-exercise/13961

I also edited the source and source_url to point directly to the Collatz conjecture page on Wikipedia. The old url was just a redirection.

@tasxatzial tasxatzial requested a review from a team as a code owner December 6, 2024 08:42
Copy link
Member

@IsaacG IsaacG left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you.

exercises/collatz-conjecture/introduction.md Outdated Show resolved Hide resolved
exercises/collatz-conjecture/introduction.md Outdated Show resolved Hide resolved
Copy link
Member

@ErikSchierboom ErikSchierboom left a comment

Choose a reason for hiding this comment

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

We're not totally consistent, but I feel like the introduction contains much of the instructions. Maybe make the rules explicit in the instructions too? And maybe remove some of it from the introduction?

@tasxatzial
Copy link
Member Author

tasxatzial commented Dec 9, 2024

We're not totally consistent, but I feel like the introduction contains much of the instructions. Maybe make the rules explicit in the instructions too? And maybe remove some of it from the introduction?

The intention was to reframe the instructions as a story. Since there isn't a real story here, I'm unsure how to incorporate your suggestion. If there are inconsistencies, I'd prefer to fix them instead.

Edit: Is the inconsistency that the intro contains the instructions?

Copy link
Member

@ErikSchierboom ErikSchierboom left a comment

Choose a reason for hiding this comment

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

Is the inconsistency that the intro contains the instructions?

It is. I'm happy to approve this and maybe tweak this later

@tasxatzial
Copy link
Member Author

The idea of putting the instructions in the intro came directly from other exercises. For example https://github.com/exercism/problem-specifications/blob/main/exercises/eliuds-eggs/introduction.md does the same. Pretty much everything we need to know is in the intro and the instructions contain only a single sentence.

@tasxatzial tasxatzial changed the title Add a story to the collatz-conjecture exercise Reframe collatz-conjecture exercise instructions as a story Dec 9, 2024
@ErikSchierboom
Copy link
Member

That's why I said we're inconsistent :)

@Cool-Katt
Copy link
Contributor

So, are we still going ahead with this PR then?

@ErikSchierboom
Copy link
Member

Sure

@Cool-Katt Cool-Katt merged commit 2d26738 into exercism:main Dec 10, 2024
7 checks passed
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.

4 participants