Skip to content

Commit 5bfb69c

Browse files
author
Jason Kerney
committedJan 6, 2022
adding exercise docs
1 parent 5c53987 commit 5bfb69c

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed
 

‎contributing.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
- [Section 1: Intention of Design](#user-content-intention-of-design)
99
- [Section 2: The Basics](#user-content-the-basics)
10-
- [Section 3: Adding a language](#user-content-adding-a-language)
10+
- [Section 3: Adding an Exercise](#user-content-adding-an-exercise)
1111
- [Section 4: Optimizations and Bug Fixes](#user-content-optimizations-and-bug-fixes)
1212

1313
## Intention of Design ##
@@ -25,14 +25,16 @@ This guide will walk you through how to contribute so that those two intents are
2525
The biggest ask I have is that any code added is well tested. I would suggest that you do it Test Driven, but do not require it.
2626

2727

28-
## Adding a language ##
28+
## Adding an Exercise ##
2929

3030
### A Note
3131

32-
Remembering the intent with adding languages, I ask that you do not look at any of the current solutions. I do not want the exercise for every language to look like every other language.
32+
Remembering the intent with adding an Exercise, I ask that you do not look at any of the current solutions. I do not want the exercise for every language to look like every other language.
3333

3434
Instead the goal is to use the best aspects of your language to recreate the desired behavior but having the solution be a language native solutions.
3535

36+
You can also read this full [guide](./new_exercises.md)
37+
3638
### Focus on Tests
3739

3840
Since the goal is expected behavior then I ask people to start by focusing on the tests. If you use the tests as a guide instead of the target code, you are in a better position for building a language native solution. This solution should be well designed.

‎documentation/contrib/lang.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
<!--bl
22
(filemeta
3-
(title "Adding a language"))
3+
(title "Adding an Exercise"))
44
/bl-->
55

66
### A Note
77

8-
Remembering the intent with adding languages, I ask that you do not look at any of the current solutions. I do not want the exercise for every language to look like every other language.
8+
Remembering the intent with adding an Exercise, I ask that you do not look at any of the current solutions. I do not want the exercise for every language to look like every other language.
99

1010
Instead the goal is to use the best aspects of your language to recreate the desired behavior but having the solution be a language native solutions.
1111

12+
You can also read this full [guide](./new_exercises.md)
13+
1214
### Focus on Tests
1315

1416
Since the goal is expected behavior then I ask people to start by focusing on the tests. If you use the tests as a guide instead of the target code, you are in a better position for building a language native solution. This solution should be well designed.

0 commit comments

Comments
 (0)
Please sign in to comment.