Skip to content

Commit 5d66a14

Browse files
authored
Revise pull request template for component images (#5738)
* Revise pull request template for component images Updated pull request template to reflect changes in file structure and naming conventions for component images. * fix image folder
1 parent 452ef7e commit 5d66a14

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
or
1414
- [ ] I am merging into `current` because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
1515

16-
- [ ] Link added in `/components/index.rst` when creating new documents for new components or cookbook.
16+
- [ ] Link added in `/components/_index.md` when creating new documents for new components or cookbook.
1717

1818
<details>
1919
<summary><strong>New Component Images</strong></summary>
@@ -22,21 +22,21 @@ If you are adding a new component to ESPHome, you can automatically generate a s
2222

2323
**To generate a component image:**
2424

25-
1. Comment on this pull request with the following command, replacing `COMPONENT_NAME` with your component name in **UPPER_CASE** format with **underscores** (e.g., `BME280`, `SHT3X`, `DALLAS_TEMP`):
25+
1. Comment on this pull request with the following command, replacing `component_name` with your component name in **lower_case** format with **underscores** (e.g., `bme280`, `sht3x`, `dallas_temp`):
2626

2727
```
28-
@esphomebot generate image COMPONENT_NAME
28+
@esphomebot generate image component_name
2929
```
3030

3131
2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
3232

33-
3. Extract the SVG file and place it in the `images/` folder of this repository.
33+
3. Extract the SVG file and place it in the `/static/images/` folder of this repository.
3434

35-
4. Use the image in your component's index table entry in `/components/index.rst`.
35+
4. Use the image in your component's index table entry in `/components/_index.md`.
3636

3737
**Example:** For a component called "DHT22 Temperature Sensor", use:
3838
```
39-
@esphomebot generate image DHT22
39+
@esphomebot generate image dht22
4040
```
4141

4242
</details>

0 commit comments

Comments
 (0)