Skip to content

Commit 73f6bd4

Browse files
Add reference to required reading in implementing guide (exercism#1170)
[Docs] Add reference to required reading in implementing guide
1 parent 434af59 commit 73f6bd4

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

reference/implementing-a-concept-exercise.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# How to implement a Python concept exercise
22

3-
This document describes the steps required to implement a concept exercise for the Python track. As this document is generic, the following placeholders are used:
3+
This document describes the steps required to implement a concept exercise for the Python track.
4+
5+
**Please please please read the docs before starting.** Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time. So, before diving into the implementation, please read the following documents:
6+
7+
- [The features of v3][docs-features-of-v3].
8+
- [Rationale for v3][docs-rationale-for-v3].
9+
- [What are concept exercise and how they are structured?][docs-concept-exercises]
10+
11+
As this document is generic, the following placeholders are used:
412

513
- `<SLUG>`: the name of the exercise in kebab-case (e.g. `anonymous-methods`).
614
- `<NAME>`: the name of the exercise in snake_case (e.g. `anonymous_methods`).
@@ -43,6 +51,7 @@ languages
4351
## Step 1: add track-specific files
4452

4553
These are files specific to the Python track:
54+
4655
- `src/<NAME>.py`: the stub implementation file, which is the starting point for students to work on the exercise.
4756
- `test/<NAME>_test.py`: the test suite.
4857
- `.meta/example.py`: an example implementation that passes all the tests.
@@ -57,3 +66,6 @@ When implementing an exercise, it can be very useful to look at already implemen
5766

5867
[reference]: ../../../reference
5968
[how-to-implement-a-concept-exercise]: ../../../docs/maintainers/generic-how-to-implement-a-concept-exercise.md
69+
[docs-concept-exercises]: ../../../docs/concept-exercises.md
70+
[docs-rationale-for-v3]: ../../../docs/rationale-for-v3.md
71+
[docs-features-of-v3]: ../../../docs/features-of-v3.md

0 commit comments

Comments
 (0)