Skip to content

Commit 028fd5a

Browse files
committed
Write short contributing instructions
1 parent 6e37d98 commit 028fd5a

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

CONTRIBUTING.md

+62
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,65 @@
22
Pull requests and issues are welcome! For major changes, please open an issue first to discuss what you would like to change.
33

44
Please make sure to update tests and docs as appropriate.
5+
6+
## Developer setup
7+
8+
### Repo
9+
10+
```bash
11+
git clone https://github.com/Oxid15/cascade.git
12+
```
13+
14+
### Installation
15+
16+
Use Python one version behind the latest as recommended.
17+
Remember to create a venv!
18+
19+
``` bash
20+
python -m venv ./venv
21+
source ./venv/bin/activate
22+
```
23+
24+
```bash
25+
cd cascade
26+
pip install -e .
27+
```
28+
29+
### Testing
30+
31+
Install requirements
32+
33+
```bash
34+
pip install -r cascade/tests/requirements.txt
35+
```
36+
37+
Run all tests
38+
39+
```bash
40+
cd cascade/tests
41+
pytest
42+
```
43+
44+
### Documentation
45+
46+
Install requirements
47+
48+
```bash
49+
pip install -r cascade/docs/requirements.txt
50+
```
51+
52+
Build the docs
53+
54+
```bash
55+
cd cascade/docs
56+
sphinx-build source build
57+
```
58+
59+
Format of docstrings is `numpy`.
60+
61+
### Code
62+
63+
Cascade uses `flake8`, `black` and `isort`. Be sure that `flake8` passes
64+
before pushing the code.
65+
66+
Each file should have license notice in the header - be sure it is included.

0 commit comments

Comments
 (0)