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
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ If you have come here to learn how to contribute to mdBook, we have some tips fo
7
7
First of all, don't hesitate to ask questions!
8
8
Use the [issue tracker](https://github.com/rust-lang/mdBook/issues), no question is too simple.
9
9
10
-
###Issue assignment
10
+
## Issue assignment
11
11
12
12
**:warning: Important :warning:**
13
13
@@ -16,7 +16,7 @@ The current PR backlog is beyond what we can process at this time.
16
16
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.
17
17
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.
18
18
19
-
###Issues to work on
19
+
## Issues to work on
20
20
21
21
If you are starting out, you might be interested in the
@@ -41,7 +41,7 @@ Issues on the issue tracker are categorized with the following labels:
41
41
-**S**-prefixed labels show the status of the issue
42
42
-**C**-prefixed labels show the category of issue
43
43
44
-
###Building mdBook
44
+
## Building mdBook
45
45
46
46
mdBook builds on stable Rust, if you want to build mdBook from source, here are the steps to follow:
47
47
@@ -56,11 +56,11 @@ mdBook builds on stable Rust, if you want to build mdBook from source, here are
56
56
57
57
The resulting binary can be found in `mdBook/target/debug/` under the name `mdbook` or `mdbook.exe`.
58
58
59
-
###Code Quality
59
+
## Code Quality
60
60
61
61
We love code quality and Rust has some excellent tools to assist you with contributions.
62
62
63
-
####Formatting Code with rustfmt
63
+
### Formatting Code with rustfmt
64
64
65
65
Before you make your Pull Request to the project, please run it through the `rustfmt` utility.
66
66
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
84
84
85
85
For more information, such as running it from your favourite editor, please see the `rustfmt` project. [rustfmt](https://github.com/rust-lang/rustfmt)
86
86
87
-
88
-
#### Finding Issues with Clippy
87
+
### Finding Issues with Clippy
89
88
90
89
[Clippy](https://doc.rust-lang.org/clippy/) is a code analyser/linter detecting mistakes, and therefore helps to improve your code.
91
90
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
99
98
cargo clippy
100
99
```
101
100
102
-
### Change requirements
101
+
## Change requirements
103
102
104
103
Please consider the following when making a change:
105
104
@@ -124,7 +123,7 @@ Please consider the following when making a change:
124
123
125
124
* Check out the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) for guidelines on designing the API.
126
125
127
-
### Making a pull-request
126
+
## Making a pull-request
128
127
129
128
When you feel comfortable that your changes could be integrated into mdBook, you can create a pull-request on GitHub.
130
129
One of the core maintainers will then approve the changes or request some changes before it gets merged.
0 commit comments