Overhaul the track README #37
Conversation
I've tried to deduplicate as much as possible, pointing to shared Exercism documentation where we have it, and only referring to language-specific changes here. I've left in a bit of high-level stuff for the sake of readability/flow.
| - Please do not commit any configuration files or directories inside the exercise other than ... | ||
|
|
||
| - Be sure to add it to the appropriate place in the `config.json` file. Also, please run `bin/fetch-configlet && bin/configlet` to ensure the exercise is configured correctly. |
There was a problem hiding this comment.
good move, because otherwise the two things done by Travis CI are split up in a weird place
|
|
||
| - Exercises should use only the {{LANGUAGE}} core libraries. | ||
| Please see the documentation about [adding new exercises](https://github.com/exercism/docs/blob/master/you-can-help/make-up-new-exercises.md). |
There was a problem hiding this comment.
will there also be a https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md section? Does the distinction no longer exist, perhaps (and we only care about in the track vs not in the track)?
There was a problem hiding this comment.
Oh, right. Hm.
I think that we should probably have separate documentation for:
- generic problem specification
- custom problem specification
- details about implementing an exercise
And then have two guides that refer to the more fleshed out data as "use cases". E.g. You want to add a brand new exercise? Here's what you need to think about. You want to implement an exercise based on a generic specification? Here's what to think about.
There was a problem hiding this comment.
I think we have some of this in https://github.com/exercism/docs/tree/master/language-tracks/exercises, so we could clean that up a bit.
I'm trying to get the documentation structured so that most of the conceptual / reference stuff is in the right place, and then the guides (do a particular task) refers to those guides. I'm still not quite there yet.
There was a problem hiding this comment.
OK, I've thought about this for a bit. I think my solution is going to be to rename the "port an exercise" guide to be "implement an exercise" (implied: given a problem specification, either general or custom).
I'll do this in a separate set of PRs, since I'll need to rename references to it across all of Exercism.
I've tried to deduplicate as much as possible, pointing to shared Exercism documentation where we have it, and only referring to language-specific changes here. I've left in a bit of high-level stuff for the sake of readability/flow.
Fixes #35
Fixes #36