comsu

AI-powered (wrapper) commit message generator

COMSU เป็นเครื่องมือบรรทัดคำสั่งที่เรียบง่าย แต่ทรงพลังที่ใช้ประโยชน์จาก Google Generative AI เพื่อแนะนำข้อความการกระทำที่มีคุณภาพสูงและกระชับตามการเปลี่ยนแปลงฉากของคุณใน GIT ทำให้กระบวนการเขียนข้อความการกระทำที่มีความหมายเป็นไปโดยอัตโนมัติและมั่นใจในความสอดคล้องในโครงการของคุณ

---

สารบัญ

• คุณสมบัติ
• การติดตั้ง
• การใช้งาน
• การบริจาค
• แสดงการสนับสนุนของคุณ

---

- คุณสมบัติ

• ข้อความการกระทำอัตโนมัติ : สร้างข้อความ commit ตามการเปลี่ยนแปลงฉากของคุณโดยใช้โมเดล AI ของ Google
• Auto Commit : มันสามารถทำการเปลี่ยนแปลงของคุณโดยอัตโนมัติด้วยข้อความ commit ที่คุณเลือก
• รองรับประเภทการกระทำทั่วไป : คำแนะนำเป็นไปตามประเภทการกระทำมาตรฐาน ( feat , fix , BUILD, build , chore , ฯลฯ )
• การตั้งค่าง่าย : การติดตั้งแบบคอมมิชชั่นเดียวเพื่อเริ่มต้นใช้งาน
• พรอมต์ที่ปรับแต่งได้ : แก้ไขไฟล์พรอมต์เพื่อปรับคำแนะนำ AI ให้ตรงกับความต้องการโครงการเฉพาะของคุณ

---

- การติดตั้ง

ลินเวกซ์

หากต้องการตั้งค่า COMSU บนระบบ Linux ของคุณให้ทำตามขั้นตอนเหล่านี้:

1. โคลนที่เก็บ :

   git clone https://github.com/ali-hv/comsu.git
   cd comsu

2. เรียกใช้สคริปต์การติดตั้ง :

   chmod +x install.sh
   sudo ./install.sh

3. ตั้งค่าคีย์ API ของคุณ :

   ตรวจสอบให้แน่ใจว่าคุณมีคีย์ Google AI Studio API ของคุณเป็นตัวแปรสภาพแวดล้อม หากคุณไม่มีคุณสามารถสร้างคีย์ API ฟรีได้ที่นี่

    export GOOGLE_AI_STUDIO_API_KEY= " your_api_key_here "

   คุณสามารถเพิ่มบรรทัดนี้ไปยัง ~/.bashrc หรือ ~/.zshrc ของคุณเพื่อทำให้มันคงอยู่

หน้าต่าง

หากต้องการตั้งค่า COMSU บนระบบ Windows ของคุณให้ทำตามขั้นตอนเหล่านี้:

1. โคลนที่เก็บ : เปิด PowerShell ในฐานะผู้ดูแลระบบจากนั้นเขียนคำสั่งเหล่านี้:

   git clone https: // github.com / ali - hv / comsu.git
   cd comsu

2. เรียกใช้สคริปต์การติดตั้ง :

   powershell - ExecutionPolicy Bypass - File install.ps1

3. ตั้งค่าคีย์ API ของคุณ :

   ตรวจสอบให้แน่ใจว่าคุณมีคีย์ Google AI Studio API ของคุณเป็นตัวแปรสภาพแวดล้อม หากคุณไม่มีคุณสามารถสร้างคีย์ API ฟรีได้ที่นี่

   set GOOGLE_AI_STUDIO_API_KEY = your_api_key_here

   คุณสามารถเพิ่มบรรทัดนี้ไปยังเส้นทาง $ ของคุณเพื่อให้คงอยู่

---

การใช้งาน

เมื่อติดตั้งแล้วคุณสามารถเรียกใช้ COMSU จากไดเรกทอรีใด ๆ ที่คุณได้ทำการเปลี่ยนแปลงขั้นตอน:

ลินเวกซ์

git comsu

หน้าต่าง

เรียกใช้สิ่งนี้ใน CMD:

git-comsu

หากคุณอาศัยอยู่ในประเทศที่ถูก จำกัด โดย Google คุณอาจต้องการใช้ VPN หรือเปลี่ยน DNS ของคุณ

สิ่งนี้จะสร้างรายการข้อความคอมมิชชันที่แนะนำตามการเปลี่ยนแปลงของคุณและคุณสามารถเลือกข้อความที่คุณต้องการจากนั้นจะทำการเปลี่ยนแปลงโดยอัตโนมัติด้วยข้อความนั้น หากคุณไม่ชอบข้อความใด ๆ คุณสามารถพิมพ์ 'x' เพื่อออก

ตัวอย่าง

git add .
git comsu

เอาท์พุท :

 Generating the commit messages based on your changes ...

1. ref: Refactor the send_email function for efficiency
2. ref: Update the send_email to reduce processing time
3. feat: Use new method for getting the changes in send_email

Write the message number you want to use (write 'x' to exit): 1

[main 6b25961] ref: Refactor the send_email function for efficiency
 1 file changed, 1 deletion(-)

Committed successfully.

---

การกำหนดค่า

พรอมต์ที่ใช้ในการสร้างข้อความ commit จะถูกเก็บไว้ในไฟล์ที่ชื่อพรอมต์ที่อยู่ที่ AT/USR/LOCAL/Share/Git-Comsu/Prompt คุณสามารถแก้ไขไฟล์นี้เพื่อเปลี่ยนวิธีการสร้างข้อความ AI

---

- การบริจาค

ยินดีต้อนรับการมีส่วนร่วมปัญหาและคำขอคุณสมบัติ! อย่าลังเลที่จะตรวจสอบหน้าปัญหา

1. แยกที่เก็บ
2. สร้างสาขาคุณสมบัติของคุณ (Git Checkout -B คุณสมบัติ/คุณสมบัติใหม่)
3. กระทำการเปลี่ยนแปลงของคุณ (git commit -m 'เพิ่มคุณสมบัติบางอย่าง')
4. ผลักดันไปยังสาขา (คุณสมบัติการผลักดัน GIT/คุณสมบัติใหม่)
5. เปิดคำขอดึง

---

- แสดงการสนับสนุนของคุณ

หากคุณพบว่าเครื่องมือนี้มีประโยชน์โปรดให้ที่เก็บ!