Skip to content

Commit 391ee3b

Browse files
authored
Merge pull request #2695 from hamirmahal/fix/invalid-heading-order-in-contributing-md
fix: invalid heading order in `CONTRIBUTING.md`
2 parents 179bd8d + ad3096e commit 391ee3b

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you have come here to learn how to contribute to mdBook, we have some tips fo
77
First of all, don't hesitate to ask questions!
88
Use the [issue tracker](https://github.com/rust-lang/mdBook/issues), no question is too simple.
99

10-
### Issue assignment
10+
## Issue assignment
1111

1212
**:warning: Important :warning:**
1313

@@ -16,7 +16,7 @@ The current PR backlog is beyond what we can process at this time.
1616
Only issues that have an [`E-Help-wanted`](https://github.com/rust-lang/mdBook/labels/E-Help-wanted) or [`Feature accepted`](https://github.com/rust-lang/mdBook/labels/Feature%20accepted) label will likely receive reviews.
1717
If there isn't already an open issue for what you want to work on, please open one first to see if it is something we would be available to review.
1818

19-
### Issues to work on
19+
## Issues to work on
2020

2121
If you are starting out, you might be interested in the
2222
[E-Easy issues](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
@@ -41,7 +41,7 @@ Issues on the issue tracker are categorized with the following labels:
4141
- **S**-prefixed labels show the status of the issue
4242
- **C**-prefixed labels show the category of issue
4343

44-
### Building mdBook
44+
## Building mdBook
4545

4646
mdBook builds on stable Rust, if you want to build mdBook from source, here are the steps to follow:
4747

@@ -56,11 +56,11 @@ mdBook builds on stable Rust, if you want to build mdBook from source, here are
5656

5757
The resulting binary can be found in `mdBook/target/debug/` under the name `mdbook` or `mdbook.exe`.
5858

59-
### Code Quality
59+
## Code Quality
6060

6161
We love code quality and Rust has some excellent tools to assist you with contributions.
6262

63-
#### Formatting Code with rustfmt
63+
### Formatting Code with rustfmt
6464

6565
Before you make your Pull Request to the project, please run it through the `rustfmt` utility.
6666
This will ensure we have good quality source code that is better for us all to maintain.
@@ -84,8 +84,7 @@ The quick guide is
8484
8585
For more information, such as running it from your favourite editor, please see the `rustfmt` project. [rustfmt](https://github.com/rust-lang/rustfmt)
8686
87-
88-
#### Finding Issues with Clippy
87+
### Finding Issues with Clippy
8988
9089
[Clippy](https://doc.rust-lang.org/clippy/) is a code analyser/linter detecting mistakes, and therefore helps to improve your code.
9190
Like formatting your code with `rustfmt`, running clippy regularly and before your Pull Request will help us maintain awesome code.
@@ -99,7 +98,7 @@ Like formatting your code with `rustfmt`, running clippy regularly and before yo
9998
cargo clippy
10099
```
101100
102-
### Change requirements
101+
## Change requirements
103102
104103
Please consider the following when making a change:
105104
@@ -124,7 +123,7 @@ Please consider the following when making a change:
124123
125124
* Check out the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) for guidelines on designing the API.
126125
127-
### Making a pull-request
126+
## Making a pull-request
128127
129128
When you feel comfortable that your changes could be integrated into mdBook, you can create a pull-request on GitHub.
130129
One of the core maintainers will then approve the changes or request some changes before it gets merged.

0 commit comments

Comments
 (0)