This repository has been archived by the owner on Mar 22, 2022. It is now read-only.
Lint: new excersices should have readme #86
Labels
Comments
|
This seems to be related to the discussion over in exercism/discussions#200. The overall trend seems to be if README's are in fact a requirement for all exercises they should be part of the |
petertseng
referenced
this issue
in petertseng/configlet
Oct 14, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The example test would fail without the attached code change. * The unit test in `lint_test.go` testing against `fixtures/numbers` actually does not fail, because there are other reasons for the track to be invalid, so the attached code change was not necessary. This points to the unit test being too coarse, but this is a discussion for another day. For now, the example test suffices. Closes exercism/discussions#200 Closes exercism/configlet#86
petertseng
referenced
this issue
in petertseng/configlet
Oct 14, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The example test would fail without the attached code change. * The unit test in `lint_test.go` testing against `fixtures/numbers` actually does not fail, because there are other reasons for the track to be invalid, so the attached code change was not necessary. This points to the unit test being too coarse, but this is a discussion for another day. For now, the example test suffices. Closes exercism/discussions#200 Closes exercism/configlet#86
petertseng
referenced
this issue
in petertseng/configlet
Oct 14, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The example test would fail without the attached code change. * The added TestMissingReadme would fail if the attached code change were incorrect. * The TestLintTrack against `fixtures/numbers` actually does not fail, because there are other reasons for the track to be invalid, so the attached code change was not necessary. This points to the unit test being too coarse, but this is a discussion for another day. For now, the other two tests suffice. Closes exercism/discussions#200 Closes exercism/configlet#86
petertseng
referenced
this issue
in petertseng/configlet
Oct 16, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The example test would fail without the attached code change. * The added TestMissingReadme would fail if the attached code change were incorrect. * The TestLintTrack against `fixtures/numbers` actually does not fail, because there are other reasons for the track to be invalid, so the attached code change was not necessary. This points to the unit test being too coarse, but this is a discussion for another day. For now, the other two tests suffice. Closes exercism/discussions#200 Closes exercism/configlet#86
petertseng
referenced
this issue
in petertseng/configlet
Oct 16, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The added TestMissingReadme would fail if the attached code change were incorrect. * The added TestLintTrack case on missing-readmes would fail without the attached code change. Closes exercism/discussions#200 Closes exercism/configlet#86
petertseng
referenced
this issue
in petertseng/configlet
Oct 16, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The added TestMissingReadme would fail if the attached code change were incorrect. * The added TestLintTrack case on missing-readmes would fail without the attached code change. Closes exercism/discussions#200 Closes exercism/configlet#86
nywilken
added
cmd/lint
enhancement
good first patch
and removed
enhancement
good first patch
labels
petertseng
referenced
this issue
in petertseng/configlet
Oct 18, 2017
After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The added TestMissingReadme would fail if the attached code change were incorrect. * The added TestLintTrack case on missing-readmes would fail without the attached code change. Closes exercism/discussions#200 Closes exercism/configlet#86
nywilken
referenced
this issue
Feb 4, 2018
* exercise: add HasReadme * fixtures: Add READMEs to linted tracks After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. This may even become required at some point. Prepare for this requirement by placing READMEs in the correct places. Note: numbers/zero does not require a README as it is foregone. * lint: Check for README presence After exercism/meta#15, READMEs are to be generated and placed into each track's exercise implementation directory. My (unsubstantiated) assumption is that they will be required to be present after Nextercism, as we don't want to keep generating READMEs on the fly. If this assumption is correct, it seems necessary to check that READMEs are present on all exercises. With the attached fixture change and attached test changes: * The added TestMissingReadme would fail if the attached code change were incorrect. * The added TestLintTrack case on missing-readmes would fail without the attached code change. Closes exercism/discussions#200 Closes exercism/configlet#86
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
My understanding is that an implementation of a new excersice should also have a copy of the readme spec added to the repo.
The text was updated successfully, but these errors were encountered: