Conversation
Contributor
|
Hi & Welcome! 👋🏽 👋 Thank you for contributing to
|
|
✅️ Have You Checked...
|
.
|
🛠️ Maintainers
Please take note 📒 of the following sections/review items 👀 ✨
🌈 Acknowledgements and Reputation
|
💫 General Code Quality
- The branch was updated & rebased with any (recent) upstream changes.
- All prose was checked for spelling and grammar.
- Files are formatted via yapf (yapf config) & conform to our coding standards
- Files pass flake8 with flake8 config & pylint with pylint config.
- Changed
example.py/exemplar.pyfiles still pass their associated test files. - Changed test files still work with associated
example.py/exemplar.pyfiles.- Check that tests fail properly, as well as succeed.
(e.g., make some tests fail on purpose to "test the tests" & failure messages).
- Check that tests fail properly, as well as succeed.
- All files have proper EOL.
- If a
JinJa2template was modified/created, was the test file regenerated?- Does the regenerated test file successfully test the exercises
example.pyfile?
- Does the regenerated test file successfully test the exercises
- The branch passes all CI checks &
configlet-lint.
Verify: |
🌿 Changes to Concept Exercises
- ❓ Are all required files still up-to-date & configured correctly for this change?_
- ❓ Does
<exercise>/.meta/design.mdneed to be updated with new implementation/design decisions - ❓ Do these changes require follow-on/supporting changes to related concept documents?
- Exercise
introduction.md- Do all code examples compile, run, and return the shown output?
- Are all the code examples formatted per the Python docs?
- Exercise
instructions.md - Exercise
hints.md - Check that exercise
design.mdwas fulfilled or edited appropriately - Exercise
exemplar.py- Only uses syntax previously introduced or explained.
- Is correct and appropriate for the exercise and story.
- Exercise
<exercise_name>.py(stub)- Includes appropriate docstrings and function names.
- Includes
passfor each function - Includes an EOL at the end
- Exercise
<exercise_name>_test.py- Tests cover all (reasonable) inputs and scenarios
- At least one test for each task in the exercise
- If using subtests or fixtures they're formatted correctly for the runner
- Classnames are
<ExerciseName>Test - Test functions are
test_<test_name>
- Exercise
config.json--> valid UUID4 - Corresponding concept
introduction.md - Corresponding concept
about.md - Concept
config.json - All Markdown Files : Prettier linting (for all markdown docs)
- All Code files: PyLint linting (except for test files)
- All files with text: Spell check & grammar review.
✨ Where applicable, check the following ✨
|
(as a reminder: Concept Exercise Anatomy) |
🚀 Changes to Practice Exercises
-
.docs/instructions.md(required)- Was this file updated and regenerated properly?
-
.docs/introduction.md(optional) -
.docs/introduction.append.md(optional) -
.docs/instructions.append.md(optional)- Are any additional instructions needed/provided?
(e.g. error handling or information on classes)
- Are any additional instructions needed/provided?
-
.docs/hints.md(optional)- Was this file regenerated properly?
-
.meta/config.json(required) -
.meta/example.py(required)- Does this pass all the current tests as written/generated?
-
.meta/design.md(optional) -
.meta/template.j2(template for generating tests from canonical data)- Was a test file properly regenerated from this template?
-
.meta/tests.toml- Are there additional test cases to include or exclude?
- Are there any Python-specific test cases needed for this exercise?
-
<exercise-slug>_test.py- Does this file need to be regenerated?
- Does this file correctly test the
example.pyfile? - Does this file correctly report test failures and messages?
-
<exercise-slug>.py(required)- Does this stub have enough information to get
the student started coding a valid solution?
- Does this stub have enough information to get
|
Is the exercise is in line with Practice Exercise Anatomy? |
🐣 Brand-New Concept Exercises
- Exercise
introduction.md- Do all code examples compile, run, and return the shown output?
- Are all the code examples formatted per the Python docs?
- Exercise
instructions.md - Exercise
hints.md - Check that exercise
design.mdwas fulfilled or edited appropriately - Exercise
exemplar.py- Only uses syntax previously introduced or explained.
- Is correct and appropriate for the exercise and story.
- Exercise
<exercise_name>.py(stub)- Includes appropriate docstrings and function names.
- Includes
passfor each function - Includes an EOL at the end
- Exercise
<exercise_name>_test.py- Tests cover all (reasonable) inputs and scenarios
- At least one test for each task in the exercise
- If using subtests or fixtures they're formatted correctly for the runner
- Classnames are
<ExerciseName>Test - Test functions are
test_<test_name>
- Exercise
config.json--> valid UUID4 - Corresponding concept
introduction.md - Corresponding concept
about.md - Concept
config.json - All Markdown Files : Prettier linting (for all markdown docs)
- All Code files: Flake8 & PyLint linting
- All Code Examples: proper formatting and fencing. Verify they run in the REPL
- All files with text: Spell check & grammar review.
|
Is the exercise is in line with Concept Exercise Anatomy? |
Our 💖 for all your review efforts! 🌟 🦄
This was referenced Jul 14, 2022
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
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.
Yayyy, that's done!