aboutsummaryrefslogtreecommitdiff
path: root/raindrops/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'raindrops/README.md')
-rw-r--r--raindrops/README.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/raindrops/README.md b/raindrops/README.md
new file mode 100644
index 0000000..3a30435
--- /dev/null
+++ b/raindrops/README.md
@@ -0,0 +1,96 @@
1# Raindrops
2
3Your task is to convert a number into a string that contains raindrop sounds corresponding to certain potential factors. A factor is a number that evenly divides into another number, leaving no remainder. The simplest way to test if a one number is a factor of another is to use the [modulo operation](https://en.wikipedia.org/wiki/Modulo_operation).
4
5The rules of `raindrops` are that if a given number:
6
7- has 3 as a factor, add 'Pling' to the result.
8- has 5 as a factor, add 'Plang' to the result.
9- has 7 as a factor, add 'Plong' to the result.
10- _does not_ have any of 3, 5, or 7 as a factor, the result should be the digits of the number.
11
12## Examples
13
14- 28 has 7 as a factor, but not 3 or 5, so the result would be "Plong".
15- 30 has both 3 and 5 as factors, but not 7, so the result would be "PlingPlang".
16- 34 is not factored by 3, 5, or 7, so the result would be "34".
17
18## Rust Installation
19
20Refer to the [exercism help page][help-page] for Rust installation and learning
21resources.
22
23## Writing the Code
24
25Execute the tests with:
26
27```bash
28$ cargo test
29```
30
31All but the first test have been ignored. After you get the first test to
32pass, open the tests source file which is located in the `tests` directory
33and remove the `#[ignore]` flag from the next test and get the tests to pass
34again. Each separate test is a function with `#[test]` flag above it.
35Continue, until you pass every test.
36
37If you wish to run all ignored tests without editing the tests source file, use:
38
39```bash
40$ cargo test -- --ignored
41```
42
43To run a specific test, for example `some_test`, you can use:
44
45```bash
46$ cargo test some_test
47```
48
49If the specific test is ignored use:
50
51```bash
52$ cargo test some_test -- --ignored
53```
54
55To learn more about Rust tests refer to the [online test documentation][rust-tests]
56
57Make sure to read the [Modules][modules] chapter if you
58haven't already, it will help you with organizing your files.
59
60## Further improvements
61
62After you have solved the exercise, please consider using the additional utilities, described in the [installation guide](https://exercism.io/tracks/rust/installation), to further refine your final solution.
63
64To format your solution, inside the solution directory use
65
66```bash
67cargo fmt
68```
69
70To see, if your solution contains some common ineffective use cases, inside the solution directory use
71
72```bash
73cargo clippy --all-targets
74```
75
76## Submitting the solution
77
78Generally 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.
79
80## Feedback, Issues, Pull Requests
81
82The [exercism/rust](https://github.com/exercism/rust) repository on 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!
83
84If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).
85
86[help-page]: https://exercism.io/tracks/rust/learning
87[modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
88[cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
89[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
90
91## Source
92
93A variation on FizzBuzz, a famous technical interview question that is intended to weed out potential candidates. That question is itself derived from Fizz Buzz, a popular children's game for teaching division. [https://en.wikipedia.org/wiki/Fizz_buzz](https://en.wikipedia.org/wiki/Fizz_buzz)
94
95## Submitting Incomplete Solutions
96It's possible to submit an incomplete solution so you can see how others have completed the exercise.