chahuadev-markdown-presenter / docs /TH /CONTRIBUTING.md
chahuadev's picture
Upload 51 files
f462b1c verified
## Thai
### จรรยาบรรณ
โปรเจกต์นี้และทุกคนที่เข้าร่วมอยู่ภายใต้ [จรรยาบรรณ](CODE_OF_CONDUCT.md) ของเรา การเข้าร่วมหมายความว่าคุณยอมรับจรรยาบรรณนี้
### ฉันสามารถมีส่วนร่วมได้อย่างไร?
#### รายงานบั๊ก
ก่อนสร้างรายงานบั๊ก โปรดตรวจสอบ [issues ที่มีอยู่](https://github.com/chahuadev/chahuadev-markdown-presenter/issues) เพื่อหลีกเลี่ยงการซ้ำซ้อน
**เมื่อสร้างรายงานบั๊ก โปรดระบุ:**
- **หัวข้อและคำอธิบายที่ชัดเจน**
- **ขั้นตอนการทำซ้ำ** ปัญหา
- **พฤติกรรมที่คาดหวัง** กับ **พฤติกรรมจริง**
- **ภาพหน้าจอ** ถ้ามี
- **รายละเอียดสภาพแวดล้อม**:
- เวอร์ชัน OS (Windows/macOS/Linux)
- เวอร์ชัน Node.js (`node --version`)
- เวอร์ชัน Electron
- เวอร์ชันแอปพลิเคชัน
#### แนะนำการปรับปรุง
การแนะนำการปรับปรุงจะถูกติดตามเป็น GitHub issues เมื่อสร้างข้อเสนอแนะ:
- **ใช้หัวข้อที่ชัดเจนและอธิบายได้**
- **ให้คำอธิบายโดยละเอียด** ของการปรับปรุงที่แนะนำ
- **อธิบายว่าทำไมการปรับปรุงนี้มีประโยชน์**
- **แสดงทางเลือกอื่น** ที่คุณพิจารณา
#### Pull Requests
**กระบวนการ:**
1. **Fork** repository
2. **สร้าง branch** จาก `main`:
```bash
git checkout -b feature/ชื่อฟีเจอร์ของคุณ
```
3. **ทำการเปลี่ยนแปลง** พร้อม commit messages ที่ชัดเจน
4. **ทดสอบอย่างละเอียด** - ตรวจสอบว่าฟังก์ชันทั้งหมดทำงาน
5. **อัปเดตเอกสาร** ถ้าจำเป็น
6. **ส่ง pull request** พร้อม:
- คำอธิบายการเปลี่ยนแปลงที่ชัดเจน
- อ้างอิงถึง issues ที่เกี่ยวข้อง
- ภาพหน้าจอ/GIFs สำหรับการเปลี่ยนแปลง UI
**แนวทาง Commit Message:**
```
type(scope): เรื่อง
เนื้อหา (ถ้ามี)
footer (ถ้ามี)
```
**ประเภท:**
- `feat`: ฟีเจอร์ใหม่
- `fix`: แก้บั๊ก
- `docs`: เปลี่ยนแปลงเอกสาร
- `style`: เปลี่ยนสไตล์โค้ด (formatting, semicolons, ฯลฯ)
- `refactor`: รีแฟกเตอร์โค้ด
- `test`: เพิ่มหรืออัปเดตเทสต์
- `chore`: งานบำรุงรักษา
### การตั้งค่าการพัฒนา
#### ความต้องการเบื้องต้น
- Node.js 18.0.0+
- npm 8.0.0+
- Git
#### เริ่มต้น
```bash
# โคลน fork ของคุณ
git clone https://github.com/YOUR_USERNAME/chahuadev-markdown-presenter.git
# เข้าไปในโฟลเดอร์
cd chahuadev-markdown-presenter
# เพิ่ม upstream remote
git remote add upstream https://github.com/chahuadev/chahuadev-markdown-presenter.git
# ติดตั้ง dependencies
npm install
# เริ่มพัฒนา
npm start
```
### มาตรฐานการเขียนโค้ด
#### JavaScript Style
- ใช้ **คุณสมบัติ ES6+** (const/let, arrow functions, template literals)
- ใช้ **ES Modules** (`import`/`export`)
- **2 spaces** สำหรับ indentation
- **Semicolons** จำเป็น
- **Single quotes** สำหรับ strings (ยกเว้น template literals)
### การทดสอบ
```bash
# รันเทสต์ (เมื่อถูกสร้าง)
npm test
# รัน linter
npm run lint
```
### เอกสาร
เมื่อเพิ่มฟีเจอร์ใหม่:
1. **อัปเดตเอกสารที่เกี่ยวข้อง** ใน `docs/`
2. **เพิ่มตัวอย่าง** เพื่อแสดงการใช้งาน
3. **อัปเดต README.md** ถ้ามีการเปลี่ยนแปลงที่ผู้ใช้เห็น
4. **เขียนเอกสารสองภาษา** (EN + TH) เมื่อเป็นไปได้
### มีคำถาม?
- เปิด issue พร้อมป้ายกำกับ `question`
- เข้าร่วมการสนทนาใน issues ที่มีอยู่
- ตรวจสอบ [เอกสาร](docs/) ก่อน
---
Thank you for contributing! 🎉
ขอบคุณสำหรับการมีส่วนร่วม! 🎉