-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add track Contributing Guide and Generator documentation #1900
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add track Contributing Guide and Generator documentation #1900
Conversation
kytrinyx
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great. I can't speak to the python-specifics, but it is lovely to see thorough documentation.
yawpitch
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent work ... only thing I'd think about changing is maybe replacing "fake_exercise" with something like "[EXERCISE]", and slightly re-arranging the order of the extra files to keep them related to the order of the files they modify.
exercises/[EXERCISE]/
├── [EXERCISE].py
├── [EXERCISE]_test.py
├── example.py
├── .meta
│ ├── template.j2
│ ├── additional_tests.json
│ └── hints.md
└── README.mdPlus updating the table to reflect and be a little bit more explicit:
- fake_exercise.py Solution stub manually created by the implementer. (See exercises/hello-world/hello_world.py)
- fake_exercise_test.py Exercise test suite; automatically generated if
.meta/template.j2is present, otherwise manually created by the implementer. (See exercises/hello-world/hello_world_test.py) - example.py Example solution manually created by the implementer and used to automatically verify the
[EXERCISE]_test.pysuite. (See exercises/hello-world/example.py) - .meta/template.j2 Test generation template; if present used to automatically generate
[EXERCISE]_test.py. (See exercises/hello-world/.meta/template.j2) - .meta/additional_tests.json Defines additional track-specific test cases; if
.meta/template.j2is also present these tests will be incorporated into the automatically generated[EXERCISE]_test.py. (See exercises/word-count/.meta/additional_tests.json) - .meta/hints.md Contains track-specific hints that are automatically included in the generated
README.md file. (See exercises/high-scores/.meta/hints.md) - README.md Exercise README automatically generated by the
configlettool. (See exercises/hello-world/hello_world.py)
I'd think grouping them together buy functionality makes the whole easier to understand than lexical ordering as they'd get from tree.
That said I'd still merge it as is if you don't agree.
Suggestions: exercism#1900 (review) Co-authored-by: Michael Morehouse <640167+yawpitch@users.noreply.github.com>
Initially I had |
yawpitch
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look great!
No description provided.