รายงานข้อผิดพลาด Slack ไปยังการแก้ไข GitHub

อธิบายข้อผิดพลาดด้วยภาษาธรรมดาใน Slack Okou เขียนปัญหา GitHub และมอบหมาย และเมื่อสาเหตุอยู่ในส่วนประกอบเดียว มันจะเปิดคำขอดึงพร้อมการแก้ไขและการทดสอบการถดถอยเพื่อให้คุณตรวจสอบ

Okou เชื่อมต่อ:SlackGitHubLinear

สิ่งที่ Okou มอบให้: จากข้อความ Slack ไปจนถึงการแก้ไขในการตรวจสอบ

เธรดจริงจากช่อง #bug-report ของทีม Okou ที่บันทึกไว้ขณะที่เกิดขึ้น เพื่อนร่วมทีมวางรายงานของลูกค้าและขอการแก้ไข สี่นาทีต่อมา Okou ได้ยื่นปัญหา GitHub พร้อมการวินิจฉัย สิบสี่นาทีหลังจากข้อความแรก มันได้เปิดคำขอดึงและโพสต์ลิงก์ตัวอย่าง ด้านล่างนี้คือทั้งสองส่วนที่บันทึกไว้: เธรดที่เริ่มต้น และคำขอดึงที่ Okou เขียน พวกเขาเป็นสาธารณะ ดังนั้นคุณสามารถอ่านปัญหา ความแตกต่าง และการตรวจสอบได้ด้วยตัวเอง

Okou · เธรด Slack เพื่อดึงคำขอรันจริง

เกิดอะไรขึ้นในเธรด

เพื่อนร่วมทีมรายงานข้อผิดพลาดเกี่ยวกับเลย์เอาต์ PWA ของลูกค้าใน #bug-report และแนบภาพหน้าจอมาด้วย Okou อ่านเธรด ติดตามไปที่แถบด้านบนที่แสดงผลโดยไม่มีระยะขอบพื้นที่ปลอดภัยของ iOS และยื่นปัญหา #11708 พร้อมป้ายกำกับและเหตุผล เมื่อเธรดขอการแก้ไข Okou ได้เปลี่ยนไฟล์หนึ่งไฟล์ (ความสูงขั้นต่ำและระยะขอบพื้นที่ปลอดภัยบนแถบด้านบนของมือถือ) เปิดคำขอดึง #11709 พร้อมลิงก์ตัวอย่าง และหยุดอยู่แค่นั้น มีคนตรวจสอบและรวมเข้าด้วยกัน

ข้อความเป็นปัญหาที่ยื่น
4 นาทีปัญหา #11708, ระบุว่าเป็นข้อผิดพลาดและ PWA
ข้อความถึงคำขอดึงข้อมูล
14 นาทีPR #11709 พร้อมลิงก์ตัวอย่าง
ไฟล์ที่เปลี่ยนแปลงโดยการแก้ไข
1รวมโดยบุคคล ไม่ใช่โดย Okou
เปิดคำขอดึง #11709 บน GitHub

การสร้างปัญหา GitHub จาก Slack หมายความว่าอย่างไร

การสร้างปัญหา GitHub จาก Slack หมายถึงการเปลี่ยนข้อบกพร่องที่ใครบางคนอธิบายในการสนทนาให้เป็นปัญหาที่มีโครงสร้างที่เหมาะสมในที่เก็บของคุณ โดยที่ไม่มีใครต้องออกจากเธรดเพื่อพิมพ์ใหม่ ส่วนที่ยากไม่เคยเป็นการเรียก API; มันคือการเขียนชื่อที่ชัดเจน, การแยกขั้นตอนการทำซ้ำออกจากพฤติกรรมที่คาดหวัง, การเลือกป้ายกำกับ, การตั้งค่าลำดับความสำคัญ, และการหาเจ้าของที่เหมาะสม Okou ทำงานนั้น มันอ่านข้อความ Slack และการตอบกลับรอบๆ, เขียนเนื้อหาปัญหา, ใช้ป้ายกำกับและลำดับความสำคัญที่สามารถอธิบายได้, แก้ไขผู้รับมอบหมายโดยการจับคู่ชื่อที่แสดง Slack กับชื่อผู้ใช้ GitHub, และโพสต์ลิงก์ปัญหาในเธรดเดียวกันเพื่อให้ผู้รายงานสามารถตรวจสอบได้ในพริบตา

ทำไมรายงานข้อบกพร่องถึงหายไปในเธรด Slack

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

Okou สร้างปัญหา GitHub จาก Slack ได้อย่างไร

ขั้นตอนที่ 1: เชื่อมต่อเครื่องมือของคุณ

GitHub
GitHub
จำเป็น
การเชื่อมต่อ OAuth กับ GitHub Okou ต้องการสิทธิ์อ่าน/เขียนเพื่อสร้างปัญหา และเมื่อมีการแก้ไข เพื่อพุชสาขาและเปิดคำขอดึง
เชื่อมต่อ
Slack
Slack
จำเป็น
Okou อ่านข้อความของคุณและตอบกลับในเธรดเดียวกัน
เชื่อมต่อ

ขั้นตอนที่ 2: ถาม Okou

Okou สร้างปัญหา: การกด ESC ในกล่องโต้ตอบกำหนดการจะปิดทันทีแม้จะมีการแก้ไขที่ยังไม่ได้บันทึก ควรขอการยืนยันก่อน มอบหมายให้ Lancy ติดป้ายเป็น bug, platform ลำดับความสำคัญปานกลาง
Okou อ่านเธรด
Okou อ่านข้อความของคุณและข้อความตอบกลับรอบๆ ดังนั้นบริบทที่มาถึงสามข้อความต่อมาก็ยังคงนับอยู่ มันระบุผู้รับมอบหมายและอนุมานป้ายกำกับและลำดับความสำคัญจากสิ่งที่ผู้คนพูดจริงๆ
ปัญหาถูกยื่นใน GitHub
ชื่อเรื่องที่เขียน, คำอธิบาย, ขั้นตอนการทำซ้ำที่แยกจากพฤติกรรมที่คาดหวัง, พื้นที่ที่ได้รับผลกระทบ, ป้ายกำกับ, และเจ้าของที่ตรงกับชื่อที่แสดงของ Slack Okou ตรวจสอบปัญหาที่เปิดอยู่ก่อนและแสดงความคิดเห็นในรายการที่ซ้ำกันแทนที่จะยื่นรายการที่สอง
Okou พบสาเหตุและเปิดคำขอพูล
เมื่อเธรดหรือโค้ดชี้ไปที่ส่วนประกอบเดียวและสามารถเขียนการทดสอบที่ล้มเหลวได้ก่อน Okou จะเขียนการแก้ไขและการทดสอบนั้น เชื่อมโยงคำขอดึงเข้ากับปัญหา และปล่อยให้ CI ทำงาน เมื่อทำไม่ได้ มันจะหยุดที่ปัญหาและบอกเหตุผลในเธรด
คุณตรวจสอบและจัดส่ง
Okou ตอบกลับในเธรดเดียวกันพร้อมปัญหา คำขอดึง และลิงก์ตัวอย่าง และขอการตรวจสอบจากเจ้าของ ไม่มีอะไรรวมกันเอง การแก้ไขจะรอคุณ

ขั้นตอนที่ 3: ก้าวไปอีกขั้น

ขอการแก้ไข
ไปเกินตั๋วเพื่อดึงคำขอ
Okou แก้ไข #6260 และเปิด PR พร้อมการทดสอบการถดถอย เชื่อมโยงกับปัญหาและโพสต์ลิงก์ตัวอย่างในเธรดนี้
เพิ่มรายละเอียดเพิ่มเติม
แนบภาพหน้าจอหรือขั้นตอนในการทำซ้ำ
Okou เพิ่มใน #6260: ขั้นตอนการทำซ้ำ 1. เปิดกล่องโต้ตอบกำหนดการ 2. พิมพ์บางอย่าง 3. กด ESC ที่คาดไว้: กล่องโต้ตอบยืนยัน
ปัญหาไฟล์แบบกลุ่ม
สร้างหลายปัญหาพร้อมกัน
Okou สร้าง 3 ปัญหาจากข้อบกพร่องเหล่านี้: 1. ปิดกล่องโต้ตอบ ESC (Lancy) 2. ตัวเลือกวันที่คลาดเคลื่อนไปหนึ่งวัน (James) 3. การอัปโหลดอวตารล้มเหลวบน Safari (Yuma)
คัดแยกอัตโนมัติ
สร้างปัญหาอัตโนมัติจากช่อง
Okou ดู #bugs เมื่อมีคนโพสต์ข้อความที่ขึ้นต้นด้วย "bug:" ให้สร้างปัญหา GitHub โดยอัตโนมัติและตอบกลับด้วยลิงก์

การรวม Slack และ GitHub ที่อยู่เบื้องหลังเวิร์กโฟลว์

นี่คือการผสานรวม Slack GitHub กับเอเจนต์ตรงกลาง: Okou อ่านการสนทนาใน Slack และเขียนบันทึกใน GitHub ตัวเชื่อมต่อแต่ละตัวจะได้รับสิทธิ์แยกต่างหากและจำกัดขอบเขตตามสิ่งที่เวิร์กโฟลว์ใช้งานจริง ดังนั้นการอ่านช่องทางจึงไม่เคยหมายถึงสิทธิ์ในการเขียนไปยังที่เก็บของคุณ

Slack

การรวม Slack: การสนทนา Okou อ่าน

จำเป็น

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

GitHub

การผสานรวม GitHub: ปัญหาที่ Okou ยื่น

จำเป็น

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

Okou เทียบกับแอป GitHub สำหรับ Slack เทียบกับเครื่องมือสร้างระบบอัตโนมัติ

การนำข้อผิดพลาดจากข้อความ Slack ไปยัง GitHub มีสามส่วน: การจับภาพรายงาน การเขียนปัญหาที่ใช้งานได้ และการส่งต่อไปยังเจ้าของ ตัวเลือกที่มีอยู่แต่ละตัวแก้ปัญหาหนึ่งในนั้น

แอป GitHub สำหรับ Slack

การพิมพ์ /github จะเปิดกล่องโต้ตอบที่คุณกรอกชื่อเรื่อง, เนื้อหา, ป้ายกำกับ และผู้รับมอบหมายด้วยตัวเอง ช่วยประหยัดเวลาในการเข้าถึงเบราว์เซอร์ แต่คุณก็ยังคงเป็นผู้เขียนปัญหา และแบบฟอร์มที่อยู่กลางการสนทนาคืออุปสรรคที่ทำให้คนพูดว่า "ฉันจะยื่นเรื่องทีหลัง"

ตัวสร้างระบบอัตโนมัติ

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

เวิร์กโฟลว์ Slack-to-GitHub ของ Okou

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

เคล็ดลับเพื่อผลลัพธ์ที่ดีขึ้น

รวมชื่อผู้รับมอบหมาย Okou จับคู่ชื่อที่แสดงของ Slack กับชื่อผู้ใช้ของ GitHub
ระบุป้ายกำกับอย่างชัดเจนหากคุณต้องการป้ายกำกับเฉพาะ มิฉะนั้น Okou จะอนุมานจากบริบท
ใช้ได้กับคำขอคุณสมบัติด้วย เพียงแค่พูดว่า "คำขอคุณสมบัติ" แทน "ข้อผิดพลาด"
พูดว่า "และเปิด PR" เมื่อคุณต้องการการแก้ไข ไม่ใช่แค่ตั๋ว Okou จะบอกคุณในเธรดว่าสาเหตุนั้นกระจายมากเกินไปที่จะเปลี่ยนแปลงได้อย่างปลอดภัยหรือไม่

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

คุณสร้างปัญหา GitHub จากข้อความ Slack ได้อย่างไร

เชื่อมต่อ Slack และ GitHub เข้ากับ Okou จากนั้นอธิบายข้อผิดพลาดในช่องและกล่าวถึง Okou มันจะอ่านข้อความและการตอบกลับรอบข้าง เขียนปัญหาพร้อมชื่อเรื่อง ขั้นตอนในการทำซ้ำ พฤติกรรมที่คาดหวัง ป้ายกำกับ และลำดับความสำคัญ สร้างในที่เก็บที่คุณตั้งชื่อ กำหนดเจ้าของ และตอบกลับในเธรดพร้อมหมายเลขปัญหาและลิงก์ คุณไม่ต้องกรอกแบบฟอร์ม

สิ่งนี้แตกต่างจากแอป GitHub สำหรับ Slack อย่างไร

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

Okou แค่แจ้งปัญหา หรือสามารถแก้ไขข้อบกพร่องได้ด้วย

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

Okou สามารถมอบหมายปัญหาให้บุคคลที่ถูกต้องโดยอัตโนมัติได้หรือไม่

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

Okou หลีกเลี่ยงการยื่นปัญหา GitHub ซ้ำกันได้อย่างไร

ก่อนที่จะสร้างสิ่งใดๆ Okou จะค้นหาปัญหาที่เปิดอยู่สำหรับอาการ พื้นที่ที่ได้รับผลกระทบ และถ้อยคำเดียวกัน เมื่อพบการจับคู่ ระบบจะเพิ่มเธรด Slack ใหม่เป็นความคิดเห็นในปัญหานั้น พร้อมด้วยผู้รายงานและเวลาประทับ และตอบกลับใน Slack ด้วยลิงก์ปัญหาที่มีอยู่แทนที่จะเปิดปัญหาที่สอง

เกิดอะไรขึ้นเมื่อรายงานข้อบกพร่องไม่มีขั้นตอนในการทำซ้ำ

Okou ยังคงยื่นปัญหาเพื่อให้รายงานไม่สูญหาย ติดป้ายกำกับว่าต้องการขั้นตอนการทำซ้ำ และตอบกลับในเธรด Slack โดยขอให้ผู้รายงานให้ข้อมูลเหล่านั้น คำตอบจะปรากฏในเธรดที่เชื่อมโยงจากปัญหาอยู่แล้ว

Okou สามารถแจ้งข้อบกพร่องจากทั้งช่องตามกำหนดเวลาได้หรือไม่

ใช่ ชี้ Okou ไปยังช่องทางหนึ่งช่องทางขึ้นไปและกำหนดตารางเวลาให้ เช่น ทุกวันศุกร์เวลา 16.00 น. มันจะอ่านข้อความประจำสัปดาห์, ยื่นปัญหาสำหรับแต่ละข้อความที่อธิบายข้อบกพร่อง, แสดงความคิดเห็นเกี่ยวกับรายการที่ซ้ำกัน, ข้ามคำขอคุณสมบัติและคำถาม, และรายงานสิ่งที่ทำไปแล้ว

สิ่งนี้ใช้ได้กับ Linear หรือ Jira แทน GitHub หรือไม่

รูปแบบเวิร์กโฟลว์เดียวกันนี้ใช้กับตัวติดตามใดๆ ที่ Okou เชื่อมต่ออยู่ หน้านี้ครอบคลุมเส้นทาง GitHub ซึ่งใช้ตัวเชื่อมต่อ GitHub Linear เชื่อมต่อในลักษณะเดียวกัน และคุณระบุชื่อตัวติดตามในคำสั่ง

ยื่นบั๊กถัดไปของคุณโดยไม่ต้องออกจาก Slack

เชื่อมต่อ Slack และ GitHub อธิบายข้อบกพร่องในแบบที่คุณจะบอกเพื่อนร่วมทีม และให้ Okou เขียนปัญหาและมอบหมาย เมื่อสาเหตุถูกจำกัด คำขอดึงข้อมูลก็จะรอคุณอยู่เช่นกัน

Okou สร้างปัญหา: การกด ESC ในกล่องโต้ตอบกำหนดการจะปิดทันทีแม้จะมีการแก้ไขที่ยังไม่ได้บันทึก ควรขอการยืนยันก่อน มอบหมายให้ Lancy ติดป้ายเป็น bug, platform ลำดับความสำคัญปานกลาง