jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-10 02:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos in maintenance docs (#1076)

Browse Source
This commit is contained in:
Dave T 2021-10-08 20:26:18 +01:00 committed by GitHub
parent 2cf6f9645e
commit c68a010a55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/maintenance.md
View File

@ -2,13 +2,13 @@
title: "Maintenance"
---
This page documents a couple of points for maintaining the Home Assistant code. Most of the tasks don't need to be performed on a regular base thus the steps, used tools, or details are preserved here.
This page documents a couple of points for maintaining the Home Assistant code. Most of the tasks don't need to be performed on a regular basis thus the steps, used tools, or details are preserved here.
## Source code
### Line separator
People are using various operating systems to develop components and platforms for Home Assistant. This could lead to different line endings on file. We prefer `LN`. Especially Microsoft Windows tools tend to use `CRLF`.
People are using various operating systems to develop components and platforms for Home Assistant. This could lead to different line endings in files. We prefer `LN`. Especially Microsoft Windows tools tend to use `CRLF`.
```shell
$ find homeassistant -name "*.py" -exec file {} \; | grep BOM
@ -23,11 +23,11 @@ $ dos2unix homeassistant/components/notify/kodi.py
### File permissions
Most files don't need to the be executable. `0644` is fine.
Most files don't need to be executable. `0644` is fine.
### Dependencies
A lot of components and platforms depends on third-party Python modules. The dependencies which are stored in the `requirements_all.txt` files can be tracked with [`pur`](https://pypi.org/project/pur/) or [`pip-upgrader`](https://github.com/simion/pip-upgrader).
A lot of components and platforms depend on third-party Python modules. The dependencies which are stored in the `requirements_all.txt` files can be tracked with [`pur`](https://pypi.org/project/pur/) or [`pip-upgrader`](https://github.com/simion/pip-upgrader).
If you update the requirements of a component/platform by updating `manifest.json`, run the provided script to update the `requirements_*.txt` file(s).
@ -40,6 +40,6 @@ Start a test run of Home Assistant. If that was successful, include all files in
## Documentation
- Merge `current` into `next` on a regular base.
- Merge `current` into `next` on a regular basis.
- Optimize the images.