Skip to content

Commit 5c92fe7

Browse files
ErikSchierboommirkoperillo
authored andcommitted
Add reference to required reading in implementing guide
[Docs] Add reference to required reading in implementing guide
1 parent a35db10 commit 5c92fe7

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

reference/implementing-a-concept-exercise.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# How to implement a Java Concept Exercise
22

3-
This document describes how to implement a Concept Exercise for the Java track. As this document is generic, the following placeholders are used:
3+
This document describes how to implement a Concept Exercise for the Java 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 snake_case (e.g. `anonymous-methods`).
614
- `<concepts>`: the Concepts the exercise is about (e.g. `loops`),
@@ -132,4 +140,7 @@ If you have any questions regarding implementing the exercise, please post them
132140
[representer]: https://github.com/exercism/java-representer
133141
[concept-exercises]: ../exercises/concept/README.md
134142
[how-to-implement-a-concept-exercise]: ../../../docs/maintainers/generic-how-to-implement-a-concept-exercise.md
143+
[docs-concept-exercises]: ../../../docs/concept-exercises.md
144+
[docs-rationale-for-v3]: ../../../docs/rationale-for-v3.md
145+
[docs-features-of-v3]: ../../../docs/features-of-v3.md
135146
[reference]: ../../../reference/README.md

0 commit comments

Comments
 (0)