Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Change example implementation to exemplar #23

Merged
merged 3 commits into from
Jan 28, 2021
Merged

Change example implementation to exemplar #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a248d7
Change example implementation to exemplar
ErikSchierboom Jan 28, 2021
7ff93e5
Update anatomy/tracks/concept-exercises.md
ErikSchierboom Jan 28, 2021
b9680ac
Update anatomy/tracks/concept-exercises.md
ErikSchierboom Jan 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion anatomy/tracks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ csharp
| | ├── .meta
| | | ├── config.json
| | | ├── design.md
| | | └── Example.cs (track-specific)
| | | └── Exemplar.cs (track-specific)
| | ├── CarsAssemble.cs (track-specific)
| | ├── CarsAssemble.csproj (track-specific)
| | └── CarsAssembleTests.cs (track-specific)
Expand Down
11 changes: 6 additions & 5 deletions anatomy/tracks/concept-exercises.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Besides these files, the following three files must be present, but their file n

- Test suite: verify a solution's correctness.
- Stub implementation: provide a starting point for students.
- Example implementation: provide an idiomatic implementation that passes all the tests.
- Exemplar implementation: provide an idiomatic implementation that passes all the tests.

### Example

Expand All @@ -63,7 +63,7 @@ exercises
├── .meta
| ├── config.json
| ├── design.md
| └── Example.cs (example implementation)
| └── Exemplar.cs (exemplar implementation)
├── CarsAssemble.cs (stub implementation)
└── CarsAssemblyTests.cs (tests)
</pre>
Expand Down Expand Up @@ -347,14 +347,15 @@ class LasagnaTest < Minitest::Test
end
```

### File: example implementation
### File: exemplar implementation

**Purpose:** Provide an idiomatic implementation that passes all the tests.
**Purpose:** Provide the target implementation that a student should aim for.

- This implementation is the target code that we want a student to aim for.
- Mentors will be shown this code as the "target" when writing feedback
- The implementation should only use language features introduced by the exercise or its prerequisites (and their prerequisites, and so on).
- The example file is _not_ shown to the student when doing in-browser coding and is _not_ downloaded to the student's file system when using the CLI.
- The exemplar file is _not_ shown to the student when doing in-browser coding and is _not_ downloaded to the student's file system when using the CLI.
ErikSchierboom marked this conversation as resolved.
Show resolved Hide resolved
- The exemplar file will be shown to mentors when commenting on solutions or representations.

#### Example

Expand Down