คัดลอกและปรับแม่แบบการมีส่วนร่วม
แทนข้อความตัวแทนแล้วตรวจทุกคำสั่งและลิงก์ เปิดรับการแก้เอกสารและรายงานบั๊กแม้ผู้ร่วมงานยังไม่พร้อมแก้โค้ดแอป
# การมีส่วนร่วม
## ก่อนเริ่ม
อ่าน README และตรวจ issue ที่มีอยู่
สำหรับการเปลี่ยนแปลงใหญ่ ให้หารือแนวทางก่อนลงมือ
## การตั้งค่าในเครื่อง
[รันไทม์ที่ต้องใช้และคำสั่งตั้งค่าที่ตรวจสอบแล้ว]
## รายงานบั๊ก
ระบุรุ่น สภาพแวดล้อม ขั้นตอน ผลที่คาดหวัง และผลที่เกิดขึ้นจริง
ลบข้อมูลลับและข้อมูลส่วนบุคคลออกจากบันทึก
## ส่ง pull request
- อธิบายปัญหาและการเปลี่ยนแปลงที่เสนอ
- จำกัดการเปลี่ยนแปลงให้ตรงประเด็น
- เรียกใช้ [การตรวจสอบเฉพาะโครงการ]
- อัปเดตเอกสารที่ได้รับผลกระทบ
## การทบทวน
[ผู้ตรวจ วิธีตอบกลับ และเวลาที่พร้อมจริง]
## วิธีช่วยอื่น ๆ
[เอกสาร ตัวอย่าง คำแปล หรือรายงานที่ทำซ้ำได้]ทำให้ค้นหาแนวทางได้ง่าย
GitHub รู้จักแนวทางมีส่วนร่วมในไดเรกทอรีรากของคลังโค้ด หรือใน docs และ .github ให้ใส่ลิงก์จาก README ด้วย เพื่อให้ผู้อ่านบทนำโครงการพบขั้นตอนได้ทันที
ตรวจเส้นทางจากจุดเริ่มมีส่วนร่วมจริงของคลังโค้ด หากมีไฟล์แนวทางหลายไฟล์ ให้รวมคำแนะนำที่ขัดแย้งกัน ผู้ร่วมงานไม่ควรได้รับคำสั่งตั้งค่าแบบหนึ่งใน README และอีกคำสั่งที่ไม่รองรับในคู่มือการมีส่วนร่วม
ออกแบบงานแรกที่เข้าถึงง่ายหนึ่งงาน
เลือกงานเล็กที่มีผลลัพธ์ชัดเจน เช่น แก้ตัวอย่างสำหรับรันไทม์ที่รองรับ อธิบายวิธีทำให้ปัญหาเกิดซ้ำ พฤติกรรมที่ต้องเปลี่ยน และวิธีตรวจว่างานเสร็จ อย่าติดป้ายว่าเหมาะสำหรับมือใหม่หากต้องใช้ความรู้ภายในที่ไม่มีเอกสาร
บอกเวลาที่พร้อมทบทวนตามจริง หากสัญญาเวลาตอบกลับไม่ได้ ให้บอกวิธีตรวจสถานะแทน ขอบเขตชัดเจนช่วยลดงานที่ถูกทิ้งค้าง และมีประโยชน์กว่าสัญญาว่าจะรวมทุกผลงาน
คำถามที่พบบ่อย
CONTRIBUTING.md แทน README.md หรือไม่?
ไม่ README อธิบายโครงการและวิธีใช้ ส่วนแนวทางมีส่วนร่วมอธิบายวิธีเสนอและตรวจสอบการเปลี่ยนแปลง
ควรคัดลอกคำสั่งทดสอบของโครงการอื่นหรือไม่?
ทำได้เฉพาะเมื่อเป็นคำสั่งที่ถูกต้องสำหรับโครงการของคุณด้วย แทนข้อความตัวแทนด้วยคำสั่งที่คุณตรวจสอบจริงแล้ว
แนวทางมีส่วนร่วมรับประกันผู้ร่วมงานเพิ่มขึ้นหรือไม่?
ไม่ แนวทางช่วยลดความไม่แน่นอนให้ผู้สนใจ แต่ประโยชน์ของโครงการ คุณภาพของงาน และการติดตามของผู้ดูแลยังสำคัญ