Skip to content

Commit 7778405

Browse files
authored
Fix CONTRIBUTING headings (#41)
- Fix heading of CONTRIBUTING.md - mkdocs: Watch for README and CONTRIBUTING files
2 parents 988a8b3 + 692767a commit 7778405

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-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

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,5 @@ plugins:
103103
# Preview controls
104104
watch:
105105
- src
106+
- README.md
107+
- CONTRIBUTING.md

0 commit comments

Comments
 (0)