mirror/rustlings
1
0
Fork 0
mirror of https://github.com/rust-lang/rustlings.git synced 2024-11-08 09:09:17 +01:00
Code Issues

Update CONTRIBUTING

Browse Source
This commit is contained in:
mo8it 2024-07-02 14:45:25 +02:00
parent 43eb014026
commit 4c5573b09f
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -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. It may take time to review your pull request.
Please be patient 😇 Please be patient 😇
When updating an exercise, check if its solution needs to be updated.
## Adding An Exercise ## Adding An Exercise
- Name the file `exercises/yourTopic/yourTopicN.rs`. - 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`. - 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. - 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. - Add the [metadata for your exercise](#exercise-metadata) in the `rustlings-macros/info.toml` file.
- Make sure your exercise runs with `rustlings run yourTopicN`. - Make sure your exercise runs with `rustlings run yourTopicN`.
- [Open a pull request](#pull-requests). - [Open a pull request](#pull-requests).
@ -49,7 +52,9 @@ The exercise metadata should contain the following:
[[exercises]] [[exercises]]
name = "yourTopicN" name = "yourTopicN"
dir = "yourTopic" 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. If your exercise doesn't contain any test, add `test = false` to the exercise metadata.