Conversation
We've had some difficulty coming up with a good name for the file that gets included in all of the exercise READMEs for a given track. These are global hints, like how to run the test suite, which are relevant to all the exercises on a track. We started with SETUP.md in the root of the repository, then renamed that to exercises/TRACK_HINTS.md because SETUP.md was misleading and confusing, but then we realized that TRACK_HINTS.md was a bit ambiguous and confusing as well. Finally we settled on putting the file in the docs directory, since this is user-facing documentation, and calling the file EXERCISE_README_INSERT.md See exercism/meta#5 for context.
Insti
approved these changes
Jun 9, 2017
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We've had some difficulty coming up with a good name for the file
that gets included in all of the exercise READMEs for a given track.
These are global hints, like how to run the test suite, which are
relevant to all the exercises on a track.
We started with SETUP.md in the root of the repository, then renamed
that to exercises/TRACK_HINTS.md because SETUP.md was misleading and
confusing, but then we realized that TRACK_HINTS.md was a bit ambiguous
and confusing as well.
Finally we settled on putting the file in the docs directory, since
this is user-facing documentation, and calling the file
EXERCISE_README_INSERT.md
See exercism/meta#5 for context.