You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,12 @@ Please make sure that all tests and linters pass for all changes. You can check
62
62
We mostly adhere to the [Rust API Guidelines Checklist](https://rust-lang.github.io/api-guidelines/checklist.html) for style and best practices.
63
63
We use `rustfmt` to keep the code well-formatted.
64
64
65
+
If you made any change that requires updating the readme, please change the lib.rs file, and then generate the README.md file by running the following command:
66
+
```bash
67
+
cargo readme --no-indent-headings > README.md
68
+
```
69
+
And make sure to re-add the nice icons when reviewing the commit diff.
70
+
65
71
### ✅ Step 5: Commit
66
72
It is recommended to keep your changes grouped logically within individual commits.
67
73
Many contributors find it easier to review changes that are split across multiple commits.
0 commit comments