Skip to content

Clarify concept exercise naming rules #78

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

Merged
merged 3 commits into from
Mar 5, 2021
Merged

Clarify concept exercise naming rules #78

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b41355
Clarify concept exercise naming rules
SaschaMann Mar 2, 2021
71d0ab0
Update anatomy/tracks/concept-exercises.md
SaschaMann Mar 2, 2021
615a9b6
Update xercise names
SaschaMann Mar 4, 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
15 changes: 8 additions & 7 deletions anatomy/tracks/concept-exercises.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,9 +460,9 @@ Good examples of names:
- `Lucian's Luscious Lasagna`
- `Calculator Conundrum`

Bad examples of names:
Disallowed names:

- `Booleans`: should not be named after a concept
- `Booleans`: uses a concept name, not a story name
- `Exercise #1`: an exercise is not a story/theme

When forking an exercise without major changes, use the original name when possible.
Expand All @@ -473,19 +473,20 @@ Each exercise also has a _slug_, which is normalized version of the exercise nam

1. Use lowercase.
1. Use [kebab-case][kebab-case].
1. Use alphanumerical characters ('a' - 'z') and dashes ('-').
1. Use latin alphanumerical characters and dashes (Regexp: `[a-z0-9-]+`)
1. Prefer written digits over numeric ones, unless there is a specific reason to prefer the digit (e.g. `two-fer` over `2-fer`)

Good examples of slugs:

- `tim-from-marketing`
- `lucians-luscious-lasagna`
- `calculator-conundrum`

Bad examples of slugs:
Disallowed slugs:

- `TIM-FROM-MARKETING`: should use lowercase (i.e. `tim-from-marketing`)
- `TimFromMarketing`: should use kebab-case (i.e. `tim-from-marketing`)
- `floating-point-numbers`: should not use a concept
- `TIM-FROM-MARKETING`: does not use lowercase (i.e. `tim-from-marketing`)
- `TimFromMarketing`: does not use kebab-case (i.e. `tim-from-marketing`)
- `floating-point-numbers`: uses a concept name, not a story name

## Presentation

Expand Down