You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -30,20 +30,20 @@ As such, building out this repo is a way we can accomplish all of these goals. I
30
30
31
31
Follow these guidelines when doing the following updates.
32
32
33
-
## Creating a new problem set
33
+
###Creating a new problem set
34
34
35
35
If you are creating a new problem set ...
36
36
37
37
1. Add an apporpiately named folder in the [`problem_sets`](../problem_sets/) folder and keep all related resources there. For example, all of the problems related to the `print()` function are in [`problem_sets/print/`](../problem_sets/print/).
38
38
2. Update the main [repo README](../README.md) to list this new problem set and add a link to the new folder.
39
39
3. Add a README.md file to the folder you created. This is where the exercises and their solutions will be listed. At the top of the README add a title and a note that exercises are generally listed in order of difficulty and put a disclaimer that presented solutions are not the only solution. Fee free to copy the paragraph at the top of [the `print()` README](../problem_sets/print/README.md).
40
40
41
-
## Adding problems to a problem set
41
+
###Adding problems to a problem set
42
42
43
43
1. Feel free to add ideas for exercises even if you aren't adding the exercise or solution notebooks. Having these problems in a single spot is helpful!
44
44
2. If you came up with the exercise on your own, feel free to give yourself credit, else add a link to the original author and url.
45
45
46
-
## Creating notebooks for exercises and solutions
46
+
###Creating notebooks for exercises and solutions
47
47
48
48
1. Exercises and their solutions should be saved in separate folders – encouraging the user to figure the problem out on their own before viewing the solution.
49
49
2. Exercises and solutions should be stored in a folder of the same name within the appropriate problem set. For example, [../problem_sets/print/exercises/](../problem_sets/print/exercises/) and [../problem_sets/print/solutions/](../problem_sets/print/solutions/).
0 commit comments