docs: Add contribution guidelines and templates for English and Korean

This commit is contained in:
eigger committed 2026-06-26 09:12:59 +09:00
1 parent 94ddb8fdda
commit e787fab0b5
9 files changed
+349 -2

No files matched your search

@@ -0,0 +1,25 @@
## Description
Please describe the vehicle template or configuration changes you are proposing.
- Added/Updated Vehicle: E.g., *Hyundai Avante CN7*
- Source Type: OBD / BLE Advertisement / GATT
- Main Features: E.g., *Added custom Mode 22 PIDs for Oil Temperature and Gear Status*
---
## Checklist
Before submitting this PR, please check the following:
- [ ] **Valid YAML Syntax**: The YAML formatting is correct and contains no parser errors.
- [ ] **No Hex Literals for IDs**: Used decimal integers for numeric parameters like `manufacturer_id` (e.g., Apple is `76`, not `0x004C`).
- [ ] **Unique Template IDs**: The new template ID is unique and doesn't conflict with existing ones in `templates.yaml`.
- [ ] **Tested & Verified**: I have tested this configuration in the HassBle app and verified that the sensor data is decoded properly.
---
## YAML Code Snippet (Optional)
If you've added a new template, you can highlight it below for a quick review:
```yaml
# Put your added template block here
```
@@ -0,0 +1,25 @@
## 변경 사항 설명 (Description)
제안하시는 차량 템플릿 또는 설정 변경 사항을 설명해 주세요.
- 추가/업데이트된 차량: 예) *현대 아반떼 CN7*
- 소스 타입: OBD / BLE Advertisement / GATT
- 주요 기능: 예) *엔진 오일 온도 및 기어 단수 커스텀 Mode 22 PID 추가*
---
## 체크리스트 (Checklist)
PR을 제출하기 전에 아래 사항들을 확인해 주세요.
- [ ] **올바른 YAML 문법**: YAML 포맷에 구문 오류가 없습니다.
- [ ] **ID 필드에 16진수(Hex) 금지**: `manufacturer_id` 등의 숫자 파라미터에는 `0x...` hex 대신 10진수 정수를 사용했습니다. (예: Apple은 `0x004C` 대신 `76`)
- [ ] **템플릿 ID 중복 확인**: 추가한 템플릿의 ID가 `templates.yaml` 내의 기존 ID와 중복되지 않습니다.
- [ ] **작동 검증 완료**: HassBle 앱에서 실제로 이 설정을 구동하여 센서 데이터가 올바르게 디코딩되는지 확인했습니다.
---
## 추가된 YAML 코드 (선택 사항)
새 템플릿이 추가된 경우 아래에 코드를 작성해 주시면 빠른 리뷰에 도움이 됩니다.
```yaml
# 여기에 추가된 템플릿 블록을 붙여넣어 주세요.
```