คู่มือโครงการ

แม่แบบบันทึกประจำรุ่น GitHub สำหรับโครงการโอเพนซอร์ส

บันทึกประจำรุ่นที่ดีบอกผู้ใช้ว่าควรอัปเกรดหรือไม่และต้องทำอะไรต่อ รายการ pull request ที่รวมแล้วเป็นหลักฐานที่มีประโยชน์ แต่มักไม่ได้อธิบายประสบการณ์อัปเกรดทั้งหมด ให้เพิ่มผลกระทบต่อผู้ใช้และสิ่งที่ต้องทำก่อนเผยแพร่

ทีมบรรณาธิการ GitHubStart · อัปเดต

เริ่มจากแม่แบบที่เน้นผู้ใช้

แทนทุกช่องในวงเล็บเหลี่ยมด้วยข้อมูลที่ตรวจสอบแล้ว ลบส่วนที่ไม่เกี่ยวข้องแทนการแต่งฟีเจอร์ หากไม่ต้องทำอะไรเพื่ออัปเกรด ให้ระบุชัดเจนหลังตรวจเส้นทางอัปเกรดที่รองรับแล้ว

# [รุ่น] — [วันที่เผยแพร่]

## สิ่งสำคัญ
- [การปรับปรุงที่ผู้ใช้เห็นและผู้ได้รับประโยชน์]

## การอัปเกรด
- จาก: [รุ่นก่อนหน้าที่รองรับ]
- การดำเนินการ: [การย้ายที่จำเป็นหรือไม่ต้องดำเนินการ]
- ตรวจสอบ: [วิธียืนยันว่าอัปเกรดสำเร็จ]

## การเปลี่ยนแปลงที่เข้ากันไม่ได้
- [พฤติกรรมที่เปลี่ยน ผู้ใช้ที่ได้รับผลกระทบ และลิงก์การย้าย]

## การแก้ไข
- [ปัญหาที่แก้แล้วและลิงก์ issue หรือ pull request]

## ปัญหาที่ทราบ
- [ข้อจำกัดที่เหลือและวิธีแก้ขัด]

## ผู้มีส่วนร่วม
[ให้เครดิตผู้มีส่วนร่วมและลิงก์ประวัติการเปลี่ยนแปลงฉบับเต็ม]

เปลี่ยนบันทึกอัตโนมัติเป็นคำอธิบายที่อ่านง่าย

GitHub สามารถสร้างบันทึกที่มี pull request ที่รวมแล้ว ผู้มีส่วนร่วม และลิงก์ประวัติการเปลี่ยนแปลงฉบับเต็ม ให้ถือผลลัพธ์เป็นร่าง ตรวจขอบเขตของรุ่น ลบรายการที่ไม่เกี่ยว และจัดกลุ่มการเปลี่ยนแปลงตามงานที่ผู้ใช้ทำ

ตัวอย่างเช่น “แก้กรณีขอบของตัวแยกวิเคราะห์” ให้คำแนะนำน้อยมาก หากตรงกับข้อเท็จจริง ให้อธิบายว่าตอนนี้นำเข้าไฟล์ CSV ที่คอลัมน์สุดท้ายว่างได้ถูกต้อง แล้วลิงก์การแก้ไขสำหรับรายละเอียดทางเทคนิค อย่าบอกว่าแก้ปัญหาการแยกวิเคราะห์ทั้งหมดแล้วหากเปลี่ยนเพียงกรณีเดียว

ตรวจเส้นทางอัปเกรดก่อนประกาศ

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

เผยแพร่ข้อมูลรุ่นก่อนนำลิงก์ไปใส่ในโพสต์ชุมชน ใช้ประกาศเน้นการปรับปรุงสำคัญหนึ่งอย่าง และให้บันทึกประจำรุ่นเป็นแหล่งรายละเอียด จดคำถามที่ตามมาและปรับคำแนะนำให้ชัดเจนเมื่อจำเป็น

คำถามที่พบบ่อย

บันทึกประจำรุ่นเหมือนประวัติการเปลี่ยนแปลงหรือไม่?

มีส่วนทับซ้อนกัน ประวัติการเปลี่ยนแปลงบันทึกสิ่งที่เปลี่ยนตามเวลา ส่วนบันทึกประจำรุ่นอธิบายรุ่นหนึ่งและผลต่อผู้ใช้ เชื่อมลิงก์ทั้งสองเพื่อให้ผู้อ่านสลับระหว่างภาพรวมกับรายละเอียดได้

เผยแพร่บันทึกที่สร้างอัตโนมัติโดยไม่แก้ไขได้หรือไม่?

ควรทบทวนก่อน ชื่อ pull request ที่นำมาสร้างอาจไม่มีขั้นตอนย้าย ผลต่อผู้ใช้ หรือปัญหาที่ทราบ

ควรใส่การเปลี่ยนโค้ดเล็กน้อยทุกอย่างในสิ่งสำคัญหรือไม่?

ไม่ ใช้ส่วนนี้กับสิ่งที่สำคัญต่อผู้ใช้ และเก็บประวัติทางเทคนิคโดยละเอียดไว้ในประวัติการเปลี่ยนแปลงที่ลิงก์ไว้

เอกสารอ้างอิง