General documentation about practice exercises
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the discussion linked in the issue, including pull request 2149 and its review, then inspect the existing learning-exercise documentation referenced in the description. Define the scope for practice-exercise guidance for maintainers and students; done means the relevant criteria, rationale, and student workflow are documented and discoverable.
Written by the indexing model from the issue text.
Description
It came up in https://github.com/exercism/problem-specifications/pull/2149#pullrequestreview-1178116799 and other conversations that we are currently missing documentation/explanation/rationale on practice exercises in general, e.g.
What makes a good practice exercise? It what ways should they challenge the student? Do we want to leave some ambiguity in the descriptions to make it more like real life or should descriptions always be as clear as possible? What are the criteria for adding a new exercise to problem spec or a track?
The above applies to the maintainer side. Additionally, we might also miss more documentation/tutorials around how to deal with practice exercises as a student (e.g. TDD, you need to select the concept to use on your own, potentially try different ones, etc.).
Sidenote: For learning exercises there is a bit more written down I think but there might be more needed as well.
- Dominant language
- No language data
- Stars
- 52
- Forks
- 98
- Avg merge
- 9m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from exercism/docs
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Similar issues
-
area:docs good first issue P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
uttrflow/uttrflow-swift#3445 ·
Maintainers usually reply within 1 day
-
adr
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
kristofdegrave/homeassistant-smart-charging#1607 ·
Maintainers usually reply within 1 day
-
Feature
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Narezzurri/OpenVPN-Config-Manager#95 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
doc good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
collective/icalendar#1865 · 2 comments ·
Maintainers usually reply within 1 day