Tối ưu hóa công việc với các dự án của bạn trên GitHub: làm quen với Kho lưu trữ mẫu Github

Xin chào mọi người, cộng đồng JavaRush! Hôm nay chúng ta sẽ nói về nguồn mở và những gì cần thiết để tạo ra một dự án chất lượng cao NGOÀI mã được viết. Điều quan trọng là viết một sản phẩm hữu ích. Nhưng không kém phần quan trọng là thiết kế chính xác của kho lưu trữ (kho lưu trữ dự án trên GitHub). Điều này sẽ giúp thực hiện một điểm quan trọng khác - quảng bá sản phẩm. Ngay cả khi dự án cực kỳ hấp dẫn nhưng nếu nó được thiết kế kém, ít nhất không được mô tả trong README (bạn có thể đọc về README là gì tại đây ), giấy phép không được nêu rõ, v.v., thì sẽ không thành công. Chỉ là sẽ không có ai chú ý đến anh ta. Và nếu ai đó để ý, họ sẽ không biết phải tương tác với anh ấy như thế nào. Có rất nhiều thứ cần phải điền đi điền lại và không dễ để lập trình viên sao chép và dán mỗi lần, và chỉ trong mùa hè này, GitHub đã phát hành tính năng Kho lưu trữ mẫu giúp thực hiện việc này. Có thể nói, để tự động hóa quá trình tạo dự án mới. Hôm nay chúng ta sẽ hiểu Kho lưu trữ là gì và Kho lưu trữ mẫu là gì. Chúng tôi sẽ mô tả những gì nên có trong dự án ngoài mã, những điều bạn cần tập trung vào. Hãy tạo Kho lưu trữ mẫu từ đầu và thêm mọi thứ cần thiết theo quan điểm của tôi. Và cuối cùng, chúng ta sẽ sử dụng Kho lưu trữ mẫu khi tạo kho lưu trữ mới. Nhưng trước tiên, hãy hiểu các điều khoản. Lý thuyết: những gì nên có trong kho lưu trữ chung của bất kỳ dự án nào Mỗi dự án nguồn mở trên GitHub đều phải có Hồ sơ cộng đồng được mô tả rõ ràng , chứa các thành phần sau.

1. Mẫu phát hành

Ở đây bạn cần mô tả các quy tắc để tạo một vấn đề trong kho lưu trữ: chúng nên được gọi là gì, nhãn là gì, ai sẽ được gán cho nó. Khi tạo một Vấn đề mới, các tùy chọn sau sẽ được cung cấp:

• Báo cáo lỗi - tạo một vấn đề để mô tả lỗi trong dự án;
• Yêu cầu tính năng - đề xuất ý tưởng mới cho dự án;
• Yêu cầu cải tiến - đề xuất cải tiến dự án;
• Mẫu vấn đề tùy chỉnh - nếu các tùy chọn khác không hoạt động, bạn có thể sử dụng mẫu trống.

Bạn có thể xem ví dụ về giao diện này tại đây .

2. Giấy phép

Giấy phép theo đó dự án được viết. Điều cần thiết là những người sẽ sử dụng dự án biết điều gì được đảm bảo và điều gì không. Ví dụ: Giấy phép Apache 2.0 có nội dung như sau:

3.ĐỌC

Đây là mô tả về dự án, danh thiếp của nó. Mọi thứ cần nói về dự án đều có ở đây. Tất nhiên, nó sẽ cần phải được mô tả mỗi lần, có tính đến các chi tiết cụ thể của dự án, nhưng các tiêu đề sẽ giống nhau. Ví dụ:

• Tổng quan - mô tả ngắn gọn về dự án;
• Cách sử dụng - cách sử dụng dự án;
• Tòa nhà - cách khởi động một dự án, những gì cần thiết cho việc này;
• Khắc phục sự cố - phần này mô tả những vấn đề bạn có thể gặp phải và cách giải quyết chúng;
• Ghi chú phát hành - mô tả các thay đổi tùy theo phiên bản;
• Tác giả - đừng quên những người thân yêu của bạn;
• Đóng góp - mô tả cách bạn có thể tham gia vào quá trình phát triển dự án;
• Quy tắc ứng xử - mô tả các quy tắc tham gia;
• RELEASE_NOTES - một tệp trong đó tất cả các thay đổi đối với phiên bản mới được ghi lại. Bạn nên đặt nội dung này vào một tài liệu riêng và lưu trữ liên kết trong README;
• ĐÓNG GÓP là một tập tin mô tả cách bạn có thể đóng góp cho sự phát triển của dự án này. Được tạo dưới dạng tệp riêng cho tiêu đề Đóng góp trong README;
• CODE_OF_CONDUCT - tệp mô tả các quy tắc tham gia phát triển dự án;
• Mẫu Yêu cầu Kéo - mẫu dành cho những người sẽ tạo yêu cầu kéo.

Tất cả những thứ này được sử dụng từ dự án này sang dự án khác, bất kể ngôn ngữ lập trình hay chi tiết cụ thể của nó.

Thực hành: tạo mẫu của riêng bạn

Như họ nói, hãy chuyển từ lời nói sang hành động. Bây giờ, bằng một ví dụ, tôi sẽ chỉ cho bạn cách tạo mẫu của riêng bạn.

1. Điều đầu tiên bạn cần là một tài khoản trên GitHub / đăng ký tại đó .

2. Tạo kho lưu trữ mới: để thực hiện việc này, nhấp vào + ở góc trên bên phải

3. Khi tạo, điền vào:

   • Tên kho lưu trữ - trong trường hợp của tôi là mẫu kho lưu trữ;
   • Mô tả - mô tả ngắn gọn về dự án;
   • Chúng tôi để chế độ Công khai, mặc dù bạn có thể chọn Riêng tư;
   • Chọn hộp khởi tạo README:

   • Chọn giấy phép theo đó dự án sẽ:

     Vì trong trường hợp của tôi, mẫu là chung nên không cần gitignore: nó sẽ được thêm vào cho một dự án và ngôn ngữ lập trình cụ thể.

     Vì vậy hãy nhấn vào Create Repository , qua đó hoàn tất quá trình tạo. Hệ thống sẽ tự động đưa chúng ta tới kho lưu trữ mới tạo.

4. Điền vào Hồ sơ cộng đồng : trong kho lưu trữ đã tạo, chuyển đến tab Thông tin chi tiết và chọn Cộng đồng :

   Như bạn có thể thấy, tất cả những gì còn lại là điền vào mẫu Quy tắc ứng xử, Đóng góp, Mẫu phát hành, Mẫu yêu cầu kéo.

   Lấy Quy tắc ứng xử làm ví dụ, chúng tôi sẽ chỉ ra cách thêm chúng vào dự án.

   Bấm thêm , hệ thống nhắc bạn chọn Giao ước cộng tác viên hoặc Quy tắc ứng xử công dân :

   Tôi chọn cái đầu tiên và nhấp vào Review and Submit .

   Tiếp theo, bạn có thể chỉnh sửa tập tin này và cam kết nó.

   Ở phía dưới, chọn tùy chọn Cam kết trực tiếp với nhánh chính và nhấp vào Cam kết tệp mới :

   Kết quả là, nếu quay lại Hồ sơ cộng đồng , chúng ta sẽ thấy Quy tắc ứng xử được đánh dấu là đã thêm:

   Mẫu đóng góp và mẫu phát hành được thêm theo cách tương tự nên tôi sẽ không hiển thị phần này. Tự làm nhé ;)

5. Thêm mẫu Yêu cầu kéo .

   Nhưng hãy nói về điều này một cách riêng biệt.

   Tôi không biết tại sao GitHub chưa thêm tùy chọn tiện lợi tương tự để thiết lập mẫu Yêu cầu kéo, vì vậy bạn sẽ phải nghiên cứu tài liệu và thêm nó theo cách thủ công.

   Để thực hiện việc này, hãy nhấp vào Tạo tệp mới trong thư mục gốc của kho lưu trữ :

   Tên tệp phải là: .github/pull_request_template.md .

   Chúng tôi thêm những gì chúng tôi cần vào mẫu và nhấp vào Cam kết tệp mới , như chúng tôi đã làm ở trên. Tôi không định phát minh lại cái bánh xe và tìm thấy một ví dụ mà tôi thấy có vẻ khá hữu dụng.

   Bằng cách này, toàn bộ Hồ sơ cộng đồng sẽ được điền vào:

6. Thêm điểm đánh dấu Kho lưu trữ mẫu .

   Để thực hiện việc này, hãy đi tới tùy chọn Cài đặt trong kho lưu trữ và chọn hộp có nội dung Kho lưu trữ mẫu:

   Và thế là xong, mẫu để tạo dự án mới đã sẵn sàng. Như vậy, chúng ta sẽ tiết kiệm được rất nhiều thời gian trong tương lai khi cần tạo dự án mới. Điều này cũng sẽ giúp bạn không bỏ lỡ các chi tiết quan trọng, vì bạn thường xảy ra trường hợp quên thêm nội dung nào đó, chẳng hạn như giấy phép hoặc mẫu rõ ràng cho một vấn đề.

Cách sử dụng Kho lưu trữ mẫu

Có hai lựa chọn để sử dụng:

1. Khi một mẫu thuộc quyền sở hữu trực tiếp của bạn: Khi tạo một kho lưu trữ mới, bạn sẽ được cung cấp tùy chọn tạo từ một mẫu từ danh sách các mẫu mà bạn sở hữu:

2. Khi mẫu là nước ngoài: không có vấn đề gì đặc biệt ở đây. Đi tới mẫu đó và nhấp vào nút Sử dụng mẫu này . Ở đây tôi sẽ sử dụng hình ảnh động từ tài liệu chính thức:

Hãy tóm tắt lại

Trong bài viết này chúng tôi đã xem xét:

• Kho lưu trữ GitHub là gì;
• Kho lưu trữ mẫu là gì;
• những gì nên có trong kho Mẫu;
• cách tạo Kho lưu trữ mẫu;
• cách sử dụng Kho lưu trữ mẫu.

Tất nhiên, dựa trên mẫu này, bạn có thể tạo những mẫu cụ thể hơn. Ví dụ: tôi đã tạo nhiều mẫu hơn với hệ thống xây dựng maven hoặc gradle đã được định cấu hình. Hơn nữa: bạn có thể tạo Mẫu kho lưu trữ khởi động mùa xuân dựa trên hai mẫu cuối cùng. Để nhóm tất cả các mẫu, tôi đã tạo một tổ chức lưu trữ mẫu trên GitHub với tất cả các mẫu. Đăng ký tài khoản GitHub của tôi

Liên kết hữu ích

• Tổ chức với tất cả các mẫu tôi đã tạo
• Blog GitHub: Tạo kho lưu trữ mới với các mẫu kho lưu trữ cách tạo mẫu cho kho lưu trữ
• Trợ giúp GitHub: Giới thiệu về kho lưu trữ và kho lưu trữ là gì.
• Trợ giúp GitHub: Tạo kho lưu trữ từ mẫu cách tạo dự án mới dựa trên mẫu
• Trợ giúp GitHub: Cấp phép mô tả kho lưu trữ cấp phép cho các dự án
• Trợ giúp GitHub: Tạo mô tả repo về việc tạo kho lưu trữ
• Mẹo Hướng dẫn Nguồn Mở để tạo/mô tả các dự án nguồn mở.
• Trợ giúp GitHub: thêm mẫu yêu cầu kéo - tạo mẫu cho yêu cầu kéo.

Thêm bài viết của tôi

• Gỡ lỗi trong Intellij IDEA: hướng dẫn dành cho người mới bắt đầu
• Hướng dẫn tạo ứng dụng khách cho API Skyscanner và xuất bản nó trong jCenter và Maven Central [Phần 1]
• Hướng dẫn tạo ứng dụng khách cho API Skyscanner và xuất bản nó trong jCenter và Maven Central [Phần 2]
• Tạo hệ thống giám sát giá vé máy bay: hướng dẫn từng bước [Phần 1]
• Tạo hệ thống giám sát giá vé máy bay: hướng dẫn từng bước [Phần 2]
• Tạo hệ thống giám sát giá vé máy bay: hướng dẫn từng bước [Phần 3]
• Ghi nhật ký: cái gì, như thế nào, ở đâu và với cái gì?
• Làm thế nào một bài kiểm tra phỏng vấn biến thành một thư viện nguồn mở
• Lịch sử thành công. 20 giờ lập trình mỗi tuần, bằng thạc sĩ và cuộc sống cá nhân
• Làm thế nào để tìm được việc làm? Lời khuyên khi gửi hồ sơ