แนวทางการมีส่วนร่วม¶
ขอบคุณสำหรับความสนใจและการมีส่วนร่วมใน OpsMini!
วิธีเข้าร่วม¶
- รายงาน Bug: ส่งใน GitHub Issues พร้อมขั้นตอนการทำซ้ำ ข้อมูลสภาพแวดล้อม ล็อก
- ข้อเสนอแนะฟีเจอร์: อธิบายสถานการณ์การใช้งานและสิ่งที่คาดหวังใน Issues
- ส่งโค้ด: Fork repository → สร้าง branch ใหม่ → commit → เปิด Pull Request
- ปรับปรุงเอกสาร: แก้ไขข้อผิดพลาดในเอกสาร เพิ่มตัวอย่างการใช้งาน
ข้อกำหนด commit¶
- PR หนึ่งอันเน้นการเปลี่ยนแปลงหนึ่งอย่าง หลีกเลี่ยงการทำทุกอย่างในครั้งเดียว
- ทำตามสไตล์โค้ดทางการของ Go (
gofmt/go vet) - ฟีเจอร์ใหม่ต้องเพิ่มกรณีทดสอบ
- ข้อความ commit อธิบายชัดเจนว่า "ทำอะไร" "ทำไม"
ข้อตกลงไดเรกทอรี¶
- การแบ่งเลเยอร์:
api/v1(Controller) →service(ธุรกิจ) →repository(ข้อมูล) - ฟิลด์ละเอียดอ่อน (คีย์ / Token) เข้ารหัสก่อนเก็บลงฐานข้อมูล
- อินเทอร์เฟซใหม่ทำตามการตอบกลับมาตรฐาน
{ code, message, data }
สัญญาอนุญาต¶
โปรเจกต์ใช้ Apache License 2.0 การส่งโค้ดถือว่ายินยอมให้อนุญาตตามสัญญาอนุญาตนี้