Thai
จรรยาบรรณ
โปรเจกต์นี้และทุกคนที่เข้าร่วมอยู่ภายใต้ จรรยาบรรณ ของเรา การเข้าร่วมหมายความว่าคุณยอมรับจรรยาบรรณนี้
ฉันสามารถมีส่วนร่วมได้อย่างไร?
รายงานบั๊ก
ก่อนสร้างรายงานบั๊ก โปรดตรวจสอบ issues ที่มีอยู่ เพื่อหลีกเลี่ยงการซ้ำซ้อน
เมื่อสร้างรายงานบั๊ก โปรดระบุ:
- หัวข้อและคำอธิบายที่ชัดเจน
- ขั้นตอนการทำซ้ำ ปัญหา
- พฤติกรรมที่คาดหวัง กับ พฤติกรรมจริง
- ภาพหน้าจอ ถ้ามี
- รายละเอียดสภาพแวดล้อม:
- เวอร์ชัน OS (Windows/macOS/Linux)
- เวอร์ชัน Node.js (
node --version) - เวอร์ชัน Electron
- เวอร์ชันแอปพลิเคชัน
แนะนำการปรับปรุง
การแนะนำการปรับปรุงจะถูกติดตามเป็น GitHub issues เมื่อสร้างข้อเสนอแนะ:
- ใช้หัวข้อที่ชัดเจนและอธิบายได้
- ให้คำอธิบายโดยละเอียด ของการปรับปรุงที่แนะนำ
- อธิบายว่าทำไมการปรับปรุงนี้มีประโยชน์
- แสดงทางเลือกอื่น ที่คุณพิจารณา
Pull Requests
กระบวนการ:
- Fork repository
- สร้าง branch จาก
main:git checkout -b feature/ชื่อฟีเจอร์ของคุณ - ทำการเปลี่ยนแปลง พร้อม commit messages ที่ชัดเจน
- ทดสอบอย่างละเอียด - ตรวจสอบว่าฟังก์ชันทั้งหมดทำงาน
- อัปเดตเอกสาร ถ้าจำเป็น
- ส่ง 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
เริ่มต้น
# โคลน 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)
การทดสอบ
# รันเทสต์ (เมื่อถูกสร้าง)
npm test
# รัน linter
npm run lint
เอกสาร
เมื่อเพิ่มฟีเจอร์ใหม่:
- อัปเดตเอกสารที่เกี่ยวข้อง ใน
docs/ - เพิ่มตัวอย่าง เพื่อแสดงการใช้งาน
- อัปเดต README.md ถ้ามีการเปลี่ยนแปลงที่ผู้ใช้เห็น
- เขียนเอกสารสองภาษา (EN + TH) เมื่อเป็นไปได้
มีคำถาม?
- เปิด issue พร้อมป้ายกำกับ
question - เข้าร่วมการสนทนาใน issues ที่มีอยู่
- ตรวจสอบ เอกสาร ก่อน
Thank you for contributing! 🎉 ขอบคุณสำหรับการมีส่วนร่วม! 🎉