search

Py-Lambdas / code-challenges

Python Code Challenges
14 stars 20 forks source link

2 Typos in README #20

Open ethyl2 opened 4 years ago

ethyl2 commented 4 years ago
  1. In "How do I get started? Fork this repository and start coding away!🚀 Test your solution by running the associated unit test. When you are reading to submit, submit a Pull Request to the submissions branch with your solution."

I believe that 'reading' should be replaced with 'ready'.

Related: are you really expecting users to submit their solutions each time they complete a challenge. If so, are those solutions accessible somewhere? It might be useful to be able to see how solutions differ, similar to what codewars does, but it might not be necessary, since each challenge has tests and therefore, the users will know whether their code is successful or not.

If the expectation is to submit your solutions, it might be helpful to include an additional explanation of how to access others' solutions.

  1. In "An example of a good challenge to use as a template for now would be the Circle challenge. SpecificA ally, your new challenge should have:"

"SpecificA ally" should be changed to "Specifically"

ethyl2 commented 4 years ago

Just to clarify, these typos are in the main README. https://github.com/Py-Lambdas/code-challenges

GitHub
Py-Lambdas/code-challenges
Python Code Challenges. Contribute to Py-Lambdas/code-challenges development by creating an account on GitHub.
birdcar commented 4 years ago

@ethyl2 thank you for opening this issue!

The typos are absolutely my fault, I was rushing to get the README updated before leading the

You're welcome to open a PR to fix them if you'd like! If not I'll get to them soon.

Related: are you really expecting users to submit their solutions each time they complete a challenge. If so, are those solutions accessible somewhere? It might be useful to be able to see how solutions differ, similar to what codewars does, but it might not be necessary, since each challenge has tests and therefore, the users will know whether their code is successful or not.

This text actually predates me, and I believe was written by @BrannanC. When I was uprooting and changing things I didn't want to tear everything out so I didn't start the conversation about ending that process, but I think this is a good time to talk about it.

Ultimately, I do agree that a central repository of solutions + how they differ could be really beneficial to people, however, I've found with code challenges that having solutions available leads to people copying and pasting code to pass tests, rather than struggling for days with something.

I'm not going to fight if we think that a way of viewing solutions is ultimately more beneficial than "forcing" people to struggle through solutions using only the hints / discord. But I will say that I personally wouldn't want to enable that and would want people to go to discord for code challenge help / mentorship.

There could potentially be a regular office hours thing we can set up for challenges, would that be a middle ground?

ethyl2 commented 4 years ago

Created PR: https://github.com/Py-Lambdas/code-challenges/pull/23