ลิงก์ไปที่หมายเลขปัญหาบน GitHub ภายในข้อความยืนยัน


คำตอบ:


952

เพียงรวม#xxxไว้ในข้อความยืนยันของคุณเพื่ออ้างอิงปัญหาโดยไม่ต้องปิด

ด้วยGitHub problems 2.0 ใหม่คุณสามารถใช้คำพ้องความหมายเหล่านี้เพื่ออ้างอิงปัญหาและปิดมัน (ในข้อความยืนยันของคุณ):

  • fix #xxx
  • fixes #xxx
  • fixed #xxx
  • close #xxx
  • closes #xxx
  • closed #xxx
  • resolve #xxx
  • resolves #xxx
  • resolved #xxx

นอกจากนี้คุณยังสามารถใช้แทนด้วย#xxxgh-xxx

ปัญหาการอ้างอิงและการปิดบัญชีใน reposก็ใช้ได้เช่นกัน:

fixes user/repo#xxx

ตรวจสอบเอกสารที่มีอยู่ในส่วนช่วยเหลือของพวกเขา


4
Fix issue #xxxใช้งานไม่ได้สำหรับฉันความคิดใด ๆ มันอ้างอิงถึงปัญหา แต่ไม่ได้ปิด
Dennis

16
@Dennis ลบคำว่า "ปัญหา"

1
@JamesTomasino ที่เป็นไปได้ - devฉันได้สังเกตเห็นว่าเรื่องนี้ยังไม่ได้รับการทำงานสำหรับฉันเมื่อฉันทำงานในสาขาที่เรียกว่า
Jon Cairns

1
แต่ละคนจะต้องใช้ในสถานการณ์ใด?
nilsi

1
ฉันจะไม่เป็นคนที่ย้ายคำตอบนี้จาก 666 คะแนนไปที่ 667 แต่มันมีประโยชน์มาก
jakeatwork

168

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

Closes #1.
Closes GH-1.
Closes gh-1.

(หนึ่งในสามรายการนี้ใช้งานได้) โปรดทราบว่าสิ่งนี้จะเชื่อมโยงกับปัญหาและปิดมัน คุณสามารถหาข้อมูลเพิ่มเติมในโพสต์บล็อกนี้(เริ่มดูวิดีโอที่ฝังอยู่ที่ประมาณ 1:40)

ฉันไม่แน่ใจว่าไวยากรณ์ที่คล้ายกันจะเชื่อมโยงกับปัญหาโดยไม่ปิดหรือไม่


31
คุณสามารถใช้หมายเลขของปัญหา (ตัวอย่างเช่น # 456) มันจะเชื่อมโยงกับงานโดยไม่ต้องปิดมัน
Matthieu Napoli

9
ฉันจะเลือก "gh-1" มากกว่า "# 1" เพียงเพราะคุณไม่มีทางรู้ว่าที่เก็บได้รับการส่งออก / มิร์เรอร์ไปยังที่อื่นที่ไม่ใช่ github จากนั้น "# 1" จะไม่สมเหตุสมผลนัก
huyz

2
@mipadi: .หลังจากที่ "ปิด GH-1` จำเป็นหรือไม่นอกจากนี้ยังเป็นกรณี ๆ ไปหรือไม่?
Lekensteyn

1
@Lekensteyn: ฉันไม่เชื่อว่าจำเป็นต้องใช้ช่วงเวลานี้ ไม่แน่ใจเกี่ยวกับตัวพิมพ์ใหญ่ - เล็ก
mipadi

message (closes GH-28)ใช้งานได้สำหรับฉันไม่แน่ใจว่าทุกอย่างตรงตามตัวพิมพ์เล็กหรือใหญ่
Lekensteyn

64

คุณยังสามารถข้าม repos อ้างอิง:

githubuser/repository#xxx

xxx เป็นหมายเลขปัญหา


62

github เพิ่มการอ้างอิงถึงการกระทำถ้ามี #issuenbr (ค้นพบโดยบังเอิญ)


4
เพิ่งผ่านการทดสอบใช้งานได้อย่างมีเสน่ห์ขอบคุณ ... นี่คือสิ่งที่ควรได้รับการระบุว่าเป็นคำตอบที่ถูกต้อง ...
opensas

14

พวกเขามีความสุขเขียนถึงปัญหาใหม่ 2.0 ในบล็อกของพวกเขา https://github.blog/2011-04-09-issues-2-0-the-next-generation/

คำพ้องความหมายรวมถึง

  • แก้ไข #xxx
  • คง #xxx
  • แก้ไข #xxx
  • ปิด #xxx
  • ปิด #xxx
  • ปิด #xxx

การใช้คำหลักใด ๆ ในข้อความยืนยันจะทำให้การกระทำของคุณถูกกล่าวถึงหรือปิดปัญหา


นั่นมีอยู่แล้วในรายการของฉันฉันไม่คิดว่าพวกเขาเป็นกรณี ๆ ไป
xero

4

เช่นเดียวกับคำตอบอื่น ๆ : หากคุณไม่ต้องการเขียนข้อความยืนยันด้วยหมายเลขปัญหาและใช้Eclipseเพื่อการพัฒนาคุณสามารถติดตั้งปลั๊กอิน eGit และ Mylyn รวมถึงตัวเชื่อมต่อ GitHub สำหรับ Mylyn ได้ จากนั้น Eclipse สามารถติดตามปัญหาที่คุณกำลังทำงานอยู่โดยอัตโนมัติและกรอกข้อความการส่งรวมถึงหมายเลขปัญหาตามที่แสดงในคำตอบอื่น ๆ ทั้งหมด

สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับการตั้งค่านั้นดูhttp://wiki.eclipse.org/EGit/GitHub/UserGuide


4

ในการเชื่อมโยงหมายเลขปัญหากับข้อความยืนยันของคุณคุณควรเพิ่ม: #issue_numberในข้อความคอมมิตของคุณ

ตัวอย่าง Commit Message จาก คู่มือความเป็นเจ้าของสไตล์ข้อความ Uditit Git

feat: Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

คุณยังสามารถอ้างอิงที่เก็บ:

githubuser/repository#issue_number

มันไม่มีเหตุผล (และทำให้ฉันรำคาญ) ที่พวกเขาใช้ "ความสำเร็จ" เป็นตัวย่อสำหรับ "คุณสมบัติ" โดยเฉพาะเมื่อในเวลาเดียวกันพวกเขาใช้ "refactor" ซึ่งยาวกว่า "คุณสมบัติ"
Michel Jung

@MichelJung คุณสามารถยืนยันว่าfeatมีการใช้งานบ่อยกว่าrefactorและไม่มีตัวย่อที่ชัดเจนสำหรับrefactor( refอาจหมายถึงการอ้างอิงrfมีความไม่ชัดเจนเกินไป ฯลฯ )
Chris Kraszewski

3

หนึ่งในโปรเจ็กต์แรกของฉันในฐานะโปรแกรมเมอร์คืออัญมณีที่เรียกว่าstagecoachซึ่งอนุญาตให้เพิ่มหมายเลข github อัตโนมัติในทุกข้อความที่ส่งไปยังสาขาซึ่งเป็นส่วนหนึ่งของคำถามที่ยังไม่ได้รับคำตอบจริงๆ .

เป็นหลักเมื่อสร้างสาขาที่คุณต้องการใช้คำสั่งที่กำหนดเอง (เช่นstagecoach -b <branch_name> -g <issue_number>) และจากนั้นหมายเลขปัญหาจะถูกกำหนดให้กับสาขานั้นในไฟล์ yml จากนั้นมีฮุกการส่งข้อมูลที่ผนวกหมายเลขปัญหากับข้อความการส่งโดยอัตโนมัติ

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


ผมคิดว่าคำตอบของคุณพยายามที่จะอยู่ที่คำถามแน่นอนจาก OP คือ "วิธีการโดยอัตโนมัติมีการเชื่อมโยงกับปัญหาที่เพิ่มขึ้นในการกระทำ" คำตอบอื่น ๆ ทั้งหมดขึ้นอยู่กับโปรแกรมเมอร์ที่จำได้ว่าต้องเพิ่ม "แก้ไข # ... แก้ไข # ... ฯลฯ " วลีของการกระทำและสิ่งนี้จะไม่เกิดขึ้นทุกครั้งที่เรารู้ Upvoting
demisx
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.