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

Adding a "Test-Driven Development" document #579

Merged
merged 12 commits into from
Jan 28, 2025
Merged

Conversation

glennj
Copy link
Contributor

@glennj glennj commented Jan 23, 2025

@glennj glennj added x:action/create Work on something from scratch x:type/docs Work on Documentation labels Jan 23, 2025
@glennj glennj marked this pull request as draft January 23, 2025 16:30
@glennj glennj marked this pull request as ready for review January 23, 2025 16:38
Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

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

Nice work! 😄
Thank you for creating this - it is going to really help a lot of students and mentors.

@iHiD
Copy link
Member

iHiD commented Jan 23, 2025

This is really great :) Thank you!

Copy link
Member

@kotp kotp 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. Approving, but with one potential suggestion.

@kotp
Copy link
Member

kotp commented Jan 24, 2025

I wonder if we should mention not submitting the test files, as once that happens, they no longer (as far as I remember) get updated when updates happen, and become the responsibility of the student to ensure that they are in a state that works for them.

At least a warning to not submit modified the test files. I have helped several students over the years that have unknowningly submitted them (usually through globbing extensions when submitting, rather than purposefully and carefully) while some know better and do so with purpose.

@glennj
Copy link
Contributor Author

glennj commented Jan 24, 2025

I wonder if we should mention not submitting the test files

This is not the place for it. I don't think I even mention the CLI at all.

Here would be better: https://exercism.org/docs/using/solving-exercises/working-locally#h-submitting-your-solution

@tasxatzial
Copy link
Member

Couple more comments:

  1. There seems to be a clear distinction between working online and working locally. However, some tracks don't have skipped tests, so there's nothing to unskip. Should this be mentioned somewhere?

  2. I can't find anywhere that TDD is the "recommended" way to solve the exercises. Should we make it clear? Many newcomers to this methodology might feel uneasy or dislike the approach, which could lead to them abandoning tracks, leaving the website, and having a negative experience overall.

@glennj
Copy link
Contributor Author

glennj commented Jan 25, 2025

some tracks don't have skipped tests, so there's nothing to unskip. Should this be mentioned somewhere?

What would you say about it? It may be more complicated than just "first comment-out all the tests and uncomment them one-by-one". I don't want to have to address the technicalities of several tracks.

I can't find anywhere that TDD is the "recommended" way to solve the exercises. Should we make it clear? Many newcomers to this methodology might feel uneasy or dislike the approach

Again, what would you say about it? I don't think we need to mandate anything, and I think this document suggests it's a good idea but does not preclude any other way. We have some exercises where "write just enough to pass the first test" is actually solving the whole exercise (I'm looking at you zebra puzzle).

@tasxatzial
Copy link
Member

It may be more complicated than just "first comment-out all the tests and uncomment them one-by-one".

That should be enough. No need to say anything about individual tracks.

I don't think we need to mandate anything, and I think this document suggests it's a good idea but does not preclude any other way

Nothing at this point. I believe the recent changes should suffice :)

Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

approved with final suggestions

Co-authored-by: Anastasios Chatzialexiou <[email protected]>
@glennj
Copy link
Contributor Author

glennj commented Jan 27, 2025

@BethanyG @iHiD @kotp @tasxatzial @ErikSchierboom @IsaacG
Is everyone still approving with the flurry of recent small changes?

@glennj glennj merged commit 15fea4d into exercism:main Jan 28, 2025
1 check passed
@glennj glennj deleted the tdd branch February 2, 2025 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/create Work on something from scratch x:type/docs Work on Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants