aboutsummaryrefslogtreecommitdiff
path: root/rust/minesweeper/HELP.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/minesweeper/HELP.md')
-rw-r--r--rust/minesweeper/HELP.md85
1 files changed, 85 insertions, 0 deletions
diff --git a/rust/minesweeper/HELP.md b/rust/minesweeper/HELP.md
new file mode 100644
index 0000000..40d8a33
--- /dev/null
+++ b/rust/minesweeper/HELP.md
@@ -0,0 +1,85 @@
1# Help
2
3## Running the tests
4
5Execute the tests with:
6
7```bash
8$ cargo test
9```
10
11All but the first test have been ignored. After you get the first test to
12pass, open the tests source file which is located in the `tests` directory
13and remove the `#[ignore]` flag from the next test and get the tests to pass
14again. Each separate test is a function with `#[test]` flag above it.
15Continue, until you pass every test.
16
17If you wish to run _only ignored_ tests without editing the tests source file, use:
18
19```bash
20$ cargo test -- --ignored
21```
22
23If you are using Rust 1.51 or later, you can run _all_ tests with
24
25```bash
26$ cargo test -- --include-ignored
27```
28
29To run a specific test, for example `some_test`, you can use:
30
31```bash
32$ cargo test some_test
33```
34
35If the specific test is ignored, use:
36
37```bash
38$ cargo test some_test -- --ignored
39```
40
41To learn more about Rust tests refer to the online [test documentation][rust-tests].
42
43[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
44
45## Submitting your solution
46
47You can submit your solution using the `exercism submit src/lib.rs Cargo.toml` command.
48This command will upload your solution to the Exercism website and print the solution page's URL.
49
50It's possible to submit an incomplete solution which allows you to:
51
52- See how others have completed the exercise
53- Request help from a mentor
54
55## Need to get help?
56
57If you'd like help solving the exercise, check the following pages:
58
59- The [Rust track's documentation](https://exercism.org/docs/tracks/rust)
60- [Exercism's support channel on gitter](https://gitter.im/exercism/support)
61- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
62
63Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
64
65## Rust Installation
66
67Refer to the [exercism help page][help-page] for Rust installation and learning
68resources.
69
70## Submitting the solution
71
72Generally you should submit all files in which you implemented your solution (`src/lib.rs` in most cases). If you are using any external crates, please consider submitting the `Cargo.toml` file. This will make the review process faster and clearer.
73
74## Feedback, Issues, Pull Requests
75
76The GitHub [track repository][github] is the home for all of the Rust exercises. If you have feedback about an exercise, or want to help implement new exercises, head over there and create an issue. Members of the rust track team are happy to help!
77
78If you want to know more about Exercism, take a look at the [contribution guide].
79
80## Submitting Incomplete Solutions
81It's possible to submit an incomplete solution so you can see how others have completed the exercise.
82
83[help-page]: https://exercism.org/tracks/rust/learning
84[github]: https://github.com/exercism/rust
85[contribution guide]: https://exercism.org/docs/community/contributors \ No newline at end of file