Skip to content

Commit 4c5573b

Browse files
committed
Update CONTRIBUTING
1 parent 43eb014 commit 4c5573b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,14 @@ If you need any help with it or face any Git related problems, don't hesitate to
3232
It may take time to review your pull request.
3333
Please be patient 😇
3434

35+
When updating an exercise, check if its solution needs to be updated.
36+
3537
## Adding An Exercise
3638

3739
- Name the file `exercises/yourTopic/yourTopicN.rs`.
38-
- Make sure to put in some helpful links, and link to sections of the book in `exercises/yourTopic/README.md`.
39-
- Add a (possible) solution at `solutions/yourTopic/yourTopicN.rs` with comments and links explaining it.
40+
- Make sure to put in some helpful links, and link to sections of The Book in `exercises/yourTopic/README.md`.
41+
- In the exercise, add a `// TODO: …` comment where user changes are required.
42+
- Add a solution at `solutions/yourTopic/yourTopicN.rs` with comments explaining it.
4043
- Add the [metadata for your exercise](#exercise-metadata) in the `rustlings-macros/info.toml` file.
4144
- Make sure your exercise runs with `rustlings run yourTopicN`.
4245
- [Open a pull request](#pull-requests).
@@ -49,7 +52,9 @@ The exercise metadata should contain the following:
4952
[[exercises]]
5053
name = "yourTopicN"
5154
dir = "yourTopic"
52-
hint = """A useful (multi-line) hint for your exercise."""
55+
hint = """
56+
A useful (multi-line) hint for your exercise.
57+
Include links to a section in The Book or a documentation page."""
5358
```
5459

5560
If your exercise doesn't contain any test, add `test = false` to the exercise metadata.

0 commit comments

Comments
 (0)