Skip to content
This repository was archived by the owner on Oct 23, 2025. It is now read-only.

Commit bf8bb49

Browse files
committed
Fix Contributing guide formatting
1 parent ce2a8eb commit bf8bb49

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ This project and everyone participating in it is governed by
1111
[this Code of Conduct](CODE_OF_CONDUCT.md).
1212
By participating, you are expected to uphold this code.
1313

14-
# Submitting bug reports
14+
## Submitting bug reports
1515

1616
Open an issue in which you:
1717

1818
- Say which version of this library, the Rust compiler, and other dependencies (if relevant) you are using
1919
- Explain what you are trying to do
2020
- Try to provide a small, reproducible example of the issue.
2121

22-
# Submitting feature requests
22+
## Submitting feature requests
2323

2424
First,
2525
please check the exising (open and closed) issues
@@ -38,7 +38,7 @@ provide a list of criteria
3838
that needs to be met by a future version of this library
3939
so you can use this feature.
4040

41-
# Submitting a pull request
41+
## Submitting a pull request
4242

4343
Do you want to submit a quick typo fix or something similar?
4444
No need to read further, just send a PR!
@@ -64,7 +64,7 @@ Please nevertheless try to include something like
6464
(where `#42` is the issue this feature is described in)
6565
in your PR description and/or commit messages.
6666

67-
## Required setup
67+
### Required setup
6868

6969
To work on this project, you'll need
7070

@@ -78,11 +78,11 @@ To work on this project, you'll need
7878

7979
[rust-docs]: https://doc.rust-lang.org/
8080

81-
## Code style
81+
### Code style
8282

8383
Every PR is checked by a continuous integration system, which
8484
compiles the code (`cargo build`),
85-
run all the tests (`cargo test`),
85+
runs all the tests (`cargo test`),
8686
checks code formatting (`cargo fmt`),
8787
and checks various lints (`cargo clippy`).
8888

@@ -92,7 +92,7 @@ before submitting your pull requests or updates to it.
9292

9393
[ci]: .travis.yml
9494

95-
## Commit messages
95+
### Commit messages
9696

9797
Your commits and their messages
9898
are what separates total confusion
@@ -113,7 +113,7 @@ It's recommended to separate larger pull requests
113113
into many small commits
114114
that build upon each other.
115115

116-
## What then?
116+
### What then?
117117

118118
After submitting your pull request,
119119
it's our turn!
@@ -133,6 +133,6 @@ Please push any changes you make
133133
after the first round of feedback
134134
as new commits to the same branch.
135135

136-
- - -
136+
## Thanks!
137137

138138
We're very much looking forward to your contributions!

0 commit comments

Comments
 (0)