diff options
| author | mo8it <mo8it@proton.me> | 2024-07-02 14:45:25 +0200 |
|---|---|---|
| committer | mo8it <mo8it@proton.me> | 2024-07-02 14:45:25 +0200 |
| commit | 4c5573b09f13221572867441618442bf1fef66d7 (patch) | |
| tree | 078804546f41c5e5634435a3767fbafe3db36f18 /CONTRIBUTING.md | |
| parent | 43eb014026e1c719bd0926cd2cb5fc7b8a18ae1f (diff) | |
Update CONTRIBUTING
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc00a6b..95605f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,11 +32,14 @@ If you need any help with it or face any Git related problems, don't hesitate to It may take time to review your pull request. Please be patient 😇 +When updating an exercise, check if its solution needs to be updated. + ## Adding An Exercise - Name the file `exercises/yourTopic/yourTopicN.rs`. -- Make sure to put in some helpful links, and link to sections of the book in `exercises/yourTopic/README.md`. -- Add a (possible) solution at `solutions/yourTopic/yourTopicN.rs` with comments and links explaining it. +- Make sure to put in some helpful links, and link to sections of The Book in `exercises/yourTopic/README.md`. +- In the exercise, add a `// TODO: …` comment where user changes are required. +- Add a solution at `solutions/yourTopic/yourTopicN.rs` with comments explaining it. - Add the [metadata for your exercise](#exercise-metadata) in the `rustlings-macros/info.toml` file. - Make sure your exercise runs with `rustlings run yourTopicN`. - [Open a pull request](#pull-requests). @@ -49,7 +52,9 @@ The exercise metadata should contain the following: [[exercises]] name = "yourTopicN" dir = "yourTopic" -hint = """A useful (multi-line) hint for your exercise.""" +hint = """ +A useful (multi-line) hint for your exercise. +Include links to a section in The Book or a documentation page.""" ``` If your exercise doesn't contain any test, add `test = false` to the exercise metadata. |