mirrors/mdBook
1
0
Fork 0
mirror of https://github.com/rust-lang/mdBook.git synced 2025-12-27 10:16:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

Use consistent sentence case for section headers

Browse Source 
There was a mix of different capitalization here, so I'm just going to
pick the one we use most often.
This commit is contained in:
Eric Huss
2025-08-16 14:52:07 -07:00
parent 03ba7d9089
commit e9e3bb6ddd
20 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -56,11 +56,11 @@ mdBook builds on stable Rust, if you want to build mdBook from source, here are
The resulting binary can be found in `mdBook/target/debug/` under the name `mdbook` or `mdbook.exe`.
## Code Quality
## Code quality
We love code quality and Rust has some excellent tools to assist you with contributions.
### Formatting Code with rustfmt
### Formatting code with rustfmt
Before you make your Pull Request to the project, please run it through the `rustfmt` utility.
This will ensure we have good quality source code that is better for us all to maintain.
@@ -84,7 +84,7 @@ The quick guide is
For more information, such as running it from your favourite editor, please see the `rustfmt` project. [rustfmt](https://github.com/rust-lang/rustfmt)
### Finding Issues with Clippy
### Finding issues with clippy
[Clippy](https://doc.rust-lang.org/clippy/) is a code analyser/linter detecting mistakes, and therefore helps to improve your code.
Like formatting your code with `rustfmt`, running clippy regularly and before your Pull Request will help us maintain awesome code.