Skip to content

Commit 0784f54

Browse files
doc: update contributing
1 parent b609f04 commit 0784f54

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

CONTRIBUTING.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ _implement a new feature! ➡️ [open an Issue to discuss it first, then a Pull
2121

2222
`rustlings` is basically a glorified `rustc` wrapper. Therefore the source code
2323
isn't really that complicated since the bulk of the work is done by `rustc`.
24-
`src/main.rs` contains a simple `clap` CLI that loads from `src/verify.rs` and `src/run.rs`.
24+
`src/main.rs` contains a simple `argh` CLI that connects to most of the other source files.
2525

2626
<a name="addex"></a>
2727
### Adding an exercise
2828

2929
The first step is to add the exercise! Name the file `exercises/yourTopic/yourTopicN.rs`, make sure to
3030
put in some helpful links, and link to sections of the book in `exercises/yourTopic/README.md`.
3131

32-
Next make sure it runs with `rustlings`. The exercise metadata is stored in `info.toml`, under the `exercises` array. The order of the `exercises` array determines the order the exercises are run by `rustlings verify`.
32+
Next make sure it runs with `rustlings`. The exercise metadata is stored in `info.toml`, under the `exercises` array. The order of the `exercises` array determines the order the exercises are run by `rustlings verify` and `rustlings watch`.
3333

3434
Add the metadata for your exercise in the correct order in the `exercises` array. If you are unsure of the correct ordering, add it at the bottom and ask in your pull request. The exercise metadata should contain the following:
3535
```diff
@@ -43,7 +43,7 @@ Add the metadata for your exercise in the correct order in the `exercises` array
4343
...
4444
```
4545

46-
The `mode` attribute decides whether Rustlings will only compile your exercise, or compile and test it. If you have tests to verify in your exercise, choose `test`, otherwise `compile`.
46+
The `mode` attribute decides whether Rustlings will only compile your exercise, or compile and test it. If you have tests to verify in your exercise, choose `test`, otherwise `compile`. If you're working on a Clippy exercise, use `mode = "clippy"`.
4747

4848
That's all! Feel free to put up a pull request.
4949

@@ -67,19 +67,19 @@ changes. There's a couple of things to watch out for:
6767
#### Write correct commit messages
6868

6969
We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
70-
specification, because it makes it easier to generate changelogs automatically.
70+
specification.
7171
This means that you have to format your commit messages in a specific way. Say
7272
you're working on adding a new exercise called `foobar1.rs`. You could write
7373
the following commit message:
7474

7575
```
76-
feat: Add foobar1.rs exercise
76+
feat: add foobar1.rs exercise
7777
```
7878

7979
If you're just fixing a bug, please use the `fix` type:
8080

8181
```
82-
fix(verify): Make sure verify doesn't self-destruct
82+
fix(verify): make sure verify doesn't self-destruct
8383
```
8484

8585
The scope within the brackets is optional, but should be any of these:
@@ -96,36 +96,35 @@ When the commit also happens to close an existing issue, link it in the message
9696
body:
9797

9898
```
99-
fix: Update foobar
99+
fix: update foobar
100100
101101
closes #101029908
102102
```
103103

104104
If you're doing simple changes, like updating a book link, use `chore`:
105105

106106
```
107-
chore: Update exercise1.rs book link
107+
chore: update exercise1.rs book link
108108
```
109109

110110
If you're updating documentation, use `docs`:
111111

112112
```
113-
docs: Add more information to Readme
113+
docs: add more information to Readme
114114
```
115115

116116
If, and only if, you're absolutely sure you want to make a breaking change
117117
(please discuss this beforehand!), add an exclamation mark to the type and
118118
explain the breaking change in the message body:
119119

120120
```
121-
fix!: Completely change verification
121+
fix!: completely change verification
122122
123123
BREAKING CHANGE: This has to be done because lorem ipsum dolor
124124
```
125125

126126
#### Pull Request Workflow
127127

128128
Once you open a Pull Request, it may be reviewed or labeled (or both) until
129-
the maintainers accept your change. Then, [bors](https://github.com/bors) will
130-
run the test suite with your changes and if it's successful, automatically
131-
merge it in!
129+
the maintainers accept your change. Please be patient, it may take some time
130+
for this to happen!

0 commit comments

Comments
 (0)