Skip to content

Commit eb38edc

Browse files
doc: Moved developer related stuff to CONTRIBUTING.md
1 parent 05a9c66 commit eb38edc

File tree

2 files changed

+42
-79
lines changed

2 files changed

+42
-79
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,45 @@ Pull requests are the best way to propose changes to the codebase.
2323

2424
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
2525

26-
## Report bugs using Github's [issues](../../issues)
27-
28-
GitHub issues are used to track public bugs.
29-
Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
30-
31-
## Write bug reports with detail, background, and sample code
32-
33-
**Great Bug Reports** tend to have:
34-
35-
- A quick summary and/or background
36-
- Steps to reproduce
37-
- Be specific!
38-
- Give sample code if you can.
39-
- What you expected would happen
40-
- What actually happens
41-
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
42-
43-
People *love* thorough bug reports. I'm not even kidding.
44-
45-
## Use a Consistent Coding Style
46-
47-
Use [black](https://github.com/ambv/black) to make sure the code follows the style.
48-
49-
## Test your code modification
50-
51-
This custom component is based on [panda_status template](https://github.com/ping-localhost/panda-status).
52-
53-
It comes with development environment in a container, easy to launch
54-
if you use Visual Studio Code. With this container you will have a stand alone
55-
Home Assistant instance running and already configured with the included
56-
[`configuration.yaml`](./config/configuration.yaml)
57-
file.
58-
59-
## License
60-
61-
By contributing, you agree that your contributions will be licensed under its MIT License.
26+
## Development
27+
28+
The easiest way to get started with development is to use Visual Studio Code with [devcontainers](https://code.visualstudio.com/docs/devcontainers/containers). This approach creates a preconfigured development environment with the necessary tools
29+
30+
You can follow the [official Home Assistant guide](https://developers.home-assistant.io/docs/setup_devcontainer_environment/) for the initial setup.
31+
32+
Below is a single, consolidated version of the two text fragments, with consistent structure, corrected numbering, and the repository URL set to `https://github.com/ping-localhost/panda-status`.
33+
34+
### Getting ready
35+
36+
1. Clone the repository to a local directory on your computer:
37+
```shell
38+
cd $HOME
39+
git clone https://github.com/ping-localhost/panda-status
40+
```
41+
3. Change into the directory of your fork and start Visual Studio Code from there:
42+
43+
```shell
44+
cd panda-status
45+
code .
46+
```
47+
4. Visual Studio Code will automatically detect the devcontainer and prompt you to **Reopen in Container** (bottom-right corner). Click this option.
48+
<p class='img'>
49+
<img src='https://developers.home-assistant.io/img/en/development/reopen_in_container.png' />
50+
</p>
51+
5. Confirm that the project is opened inside the devcontainer.
52+
6. Run the setup script:
53+
```shell
54+
./scripts/setup
55+
```
56+
57+
This step will:
58+
59+
* Install `uv` if it is not already installed,
60+
* Create a virtual environment if needed,
61+
* Activate the environment, and
62+
* Install all required dependencies.
63+
7. Start the development environment by running:
64+
```shell
65+
./scripts/develop
66+
```
67+
8. Home Assistant will then be available with this custom component at: `http://localhost:8123/`.

README.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -77,49 +77,6 @@ After installation, add the integration via Home Assistant UI:
7777

7878
For issues or feature requests, open an [issue on GitHub](https://github.com/ping-localhost/panda-status/issues).
7979

80-
## Development
81-
82-
The easiest way to get started with development is to use Visual Studio Code with [devcontainers](https://code.visualstudio.com/docs/devcontainers/containers). This approach creates a preconfigured development environment with the necessary tools
83-
84-
You can follow the [official Home Assistant guide](https://developers.home-assistant.io/docs/setup_devcontainer_environment/) for the initial setup.
85-
86-
Below is a single, consolidated version of the two text fragments, with consistent structure, corrected numbering, and the repository URL set to `https://github.com/ping-localhost/panda-status`.
87-
88-
### Getting ready
89-
90-
1. Clone the repository to a local directory on your computer:
91-
```shell
92-
cd $HOME
93-
git clone https://github.com/ping-localhost/panda-status
94-
```
95-
3. Change into the directory of your fork and start Visual Studio Code from there:
96-
97-
```shell
98-
cd panda-status
99-
code .
100-
```
101-
4. Visual Studio Code will automatically detect the devcontainer and prompt you to **Reopen in Container** (bottom-right corner). Click this option.
102-
<p class='img'>
103-
<img src='https://developers.home-assistant.io/img/en/development/reopen_in_container.png' />
104-
</p>
105-
5. Confirm that the project is opened inside the devcontainer.
106-
6. Run the setup script:
107-
```shell
108-
./scripts/setup
109-
```
110-
111-
This step will:
112-
113-
* Install `uv` if it is not already installed,
114-
* Create a virtual environment if needed,
115-
* Activate the environment, and
116-
* Install all required dependencies.
117-
7. Start the development environment by running:
118-
```shell
119-
./scripts/develop
120-
```
121-
8. Home Assistant will then be available with this custom component at: `http://localhost:8123/`.
122-
12380
## License
12481

12582
Distributed under the MIT License. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)