File: CONTRIBUTING.md

package info (click to toggle)
blueprint-compiler 0.18.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,140 kB
  • sloc: python: 8,504; sh: 31; makefile: 6
file content (28 lines) | stat: -rw-r--r-- 508 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
First of all, thank you for contributing to Blueprint.

If you learn something useful, please add it to this file.

# Run the test suite

```sh
python -m unittest
```

# Formatting

Blueprint uses [Black](https://github.com/psf/black) for code formatting.

# Build the docs

```sh
pip install -U sphinx furo

meson -Ddocs=true build
# or
meson --reconfigure -Ddocs=true build

ninja -C build docs/en

python -m http.server 2310 --bind 127.0.0.1 --directory build/docs/en/
xdg-open http://127.0.0.1:2310/
```