Skip to content

Commit d5b6f21

Browse files
committed
Create contributing guide
Add a CONTRIBUTING.md guide explaining how to build, test and setup a development environment. Also mention the contributing guide in the README.md. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent a4c1243 commit d5b6f21

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Contributing to `frequenz-channels`
2+
===================================
3+
4+
5+
Build
6+
=====
7+
8+
You can use `build` to simply build the source and binary distribution:
9+
10+
```sh
11+
python -m pip install build
12+
python -m build
13+
```
14+
15+
Local development
16+
=================
17+
18+
You can use editable installs to develop the project locally (it will install
19+
all the dependencies too):
20+
21+
```sh
22+
python -m pip install -e .
23+
```
24+
25+
You can also use `nox` to run the tests and other checks:
26+
27+
```sh
28+
python -m pip install nox
29+
nox
30+
```

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Frequenz channels
22

33
This repository contains channel implementations for python.
4+
5+
## Contributing
6+
7+
If you want to know how to build this project and contribute to it, please
8+
check out the [Contributing
9+
Guide](https://github.com/frequenz-floss/frequenz-channels/CONTRIBUTING.md).

0 commit comments

Comments
 (0)