Github pull request template – giao tiếp nhóm tốt hơn

Vấn đề

Khi làm việc với github, 2 thao tác chúng ta hay làm hàng ngày đó là Pull Request (PR)Issue.

Khi tạo một PR hay Issue, thường chúng ta sẽ nhập thông tin mô tả (description) về PR hay Issue đó. Để việc truyền đạt thông tin được thuận lợi hơn, các tổ chức thường đưa ra 1 template về description.

Mỗi tổ chức sẽ có một template khác nhau, việc này khiến ta loạn trong việc lưu trữ, ghi nhớ.

Gần đây, từ yêu cầu của cộng đồng, github đã ra mắt tính năng tạo template cho PR và Issue.

Pull Request Template

Với tính năng này, mỗi khi bạn tạo 1 PR, nội dung template sẽ được điền thẳng vào description luôn, bạn chỉ việc viết theo template, quá tiện 😛

Screenshot from 2016-03-23 16:09:59

Để tạo template này, cực kỳ đơn giản, tại thư mục gốc của dự án, bạn tạo thư mục .github, trong thư mục .github mới tạo, tạo file PULL_REQUEST_TEMPLATE.md.

Đuôi file là .md (markdown) để khi hiển thị ra đẹp hơn, còn bạn hoàn toàn có thể không dùng đuôi tên file, hoặc dùng .txt cũng được.

Nội dung file như sau:

Đây là mẫu công ty mình đang dùng, bạn hoàn toàn có thể dùng template theo ý bạn.

Nội dung sẽ được điền tự động vào khung mô tả

Nội dung sẽ được điền tự động vào khung mô tả

Issue Template

Tương tự PR Template, file issue template sẽ có tên là ISSUE_TEMPLATE.md và đặt cùng thư mục luôn.

Kết

Vậy là với vài bước cấu hình đơn giản, từ nay, việc tương tác nhóm sẽ thuận lợi hơn rất nhiều 😀

Lập trình và hơn thế nữa

Spread the love
  •  
  •  
  •  
  •  
  •  

Leave a Reply

Be the First to Comment!

avatar
  Subscribe  
Notify of