You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
41
41
- What actually happens
42
42
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
43
43
44
-
People *love* thorough bug reports. I'm not even kidding.
44
+
People _love_ thorough bug reports. I'm not even kidding.
45
45
46
46
## Use a Consistent Coding Style
47
47
@@ -53,14 +53,16 @@ Visual Studio Code is the recommended code editor for this project.
53
53
This project includes a [devcontainer](./.devcontainer) configuration for an easy to use and consistent development environment. With this container you will have a stand alone Home Assistant instance running and already configured with the included [`configuration.yaml`](./config/configuration.yaml) file.
54
54
55
55
### Dependency management
56
+
56
57
Dependencies are managed via [Poetry](https://python-poetry.org). This will be managed for you automatically if using the dev container. If you wish to run outside of a dev container, you will need to install your dependencies manually:
57
58
58
59
```sh
59
-
pip install poetry~=1.8
60
+
pip install poetry~=2.2.1
60
61
poetry install
61
62
```
62
63
63
64
### Running tests
65
+
64
66
Use `./scripts/test` to invoke the test runner.
65
67
66
68
You must be within the virtual environment where project dependencies are installed:
@@ -78,11 +80,13 @@ poetry shell
78
80
```
79
81
80
82
### Updating snapshots
83
+
81
84
If you've made a change to code that impacts a snapshot, your test will fail and the snapshot needs to be updated. To update snapshots run /bin/bash ./scripts/update_snapshots
82
85
83
86
Or in vscode you can run one of the two update snapshot tasks by opening the command pallete with cmd + p (or ctrl + p), and type `task Update` to see the tasks related to updating snapshots.
84
87
85
88
### Linting
89
+
86
90
In the devcontainer, linting and formatting runs on save and linting errors are showed as PROBLEMS in vscode.
87
91
88
92
To invoke a full lint/format, in vscode open the command pallete with cmd + p (or ctrl + p), and type `task Lint`.
0 commit comments