Skip to content

Commit 135cb44

Browse files
committed
Fix heading of CONTRIBUTING.md
All sections were using headings with level 1, which is not included in the ToC of the generated docs. We also use a syntax that makes it easier to see which level of heading we are using. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 2afc365 commit 135cb44

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
Contributing to `frequenz-channels`
2-
===================================
1+
# Contributing to `frequenz-channels`
32

43

5-
Build
6-
=====
4+
## Build
75

86
You can use `build` to simply build the source and binary distribution:
97

@@ -12,8 +10,7 @@ python -m pip install build
1210
python -m build
1311
```
1412

15-
Local development
16-
=================
13+
## Local development
1714

1815
You can use editable installs to develop the project locally (it will install
1916
all the dependencies too):
@@ -81,8 +78,7 @@ That said, if you want to test the actual website in **your fork**, you can
8178
always use `mike deploy --push --remote your-fork-remote`, and then access the
8279
GitHub pages produced for your fork.
8380

84-
Releasing
85-
=========
81+
## Releasing
8682

8783
These are the steps to create a new release:
8884

0 commit comments

Comments
 (0)