LibrePatch
Quy trình làm việc

Phần mềm nguồn mở miễn phí: liệt kê giấy phép, sau đó sửa và kiểm thử

03
Kiểm tra giấy phép

Liệt kê các phụ thuộc và đọc từng giấy phép trước khi đóng góp

Bạn mở thư mục của một dự án bạn dự định thay đổi và muốn biết các giấy phép của các phụ thuộc của nó trước khi gửi một đóng góp. Agent liệt kê các tệp, đọc các văn bản giấy phép và tạo bảng các gói, phiên bản và giấy phép. Kết quả là một bảng mà bạn kiểm tra từng hàng đối chiếu với các văn bản giấy phép, và bạn sửa những gì sai. Đó là bản nháp giúp bạn đặt đúng câu hỏi, và các tệp riêng của dự án vẫn là nguồn sự thật. Hãy thực hiện 4 bước dưới đây theo thứ tự, và dừng lại ở bất kỳ bước nào nếu có điều gì đó không rõ ràng.

01

Mở thư mục

Mở thư mục của dự án trong một cuộc trò chuyện mới và chọn Ask first, để mọi thay đổi đều được hiển thị cho bạn trước khi được ghi. Kiểm tra xem thư mục có phải là dự án bạn có thể thay đổi hay không, và không phải là bản sao thuộc về người khác. Việc này mất một phút. Sử dụng một cuộc trò chuyện mới cho mỗi dự án.

02

Liệt kê các tệp

Hãy để list_dir và glob tìm các tệp phụ thuộc và các tệp giấy phép, và đọc danh sách kết quả mà agent hiển thị trong cuộc trò chuyện. Mở bất kỳ thẻ nào có vẻ bất thường, vì một thẻ hiển thị kết quả đầy đủ. Không có gì được chỉnh sửa trong bước này. Hãy dành thời gian.

03

Đọc các giấy phép

Sử dụng read_file và grep để đọc các văn bản giấy phép và các dòng SPDX, và ghi chú bất cứ điều gì bạn không hiểu, để bạn có thể hỏi dự án về điều đó. Mã không có giấy phép, ở hầu hết các quốc gia, không được tự do để tái sử dụng. Bạn chỉ đang đọc ở đây, không thay đổi các tệp.

04

Kiểm tra kết quả

Xem lại tệp CSV và diff, sau đó so sánh từng hàng với văn bản giấy phép của nó và chạy các bài kiểm thử của dự án nếu bạn đã thay đổi các tệp. Chỉ chấp nhận những gì bạn đã hiểu, và từ chối phần còn lại. Sau đó, tự gửi đóng góp, như dự án yêu cầu. Hãy giữ một bản sao của danh mục.

Ví dụ về danh mục giấy phép trong một tệp CSV

licenses.csv
package,version,licence,note
lib-a,1.0,MIT,keep notice
lib-b,2.0,BSD-3-Clause,keep notice
lib-c,1.5,Apache-2.0,keep notice
lib-d,3.0,MPL-2.0,share file changes
lib-e,1.2,GPL-3.0-only,share changes
lib-f,2.1,MIT,keep notice
lib-g,1.0,BSD-3-Clause,keep notice
lib-h,1.1,Apache-2.0,keep notice

Tệp liệt kê tám gói ví dụ với tên giả định, phiên bản và các định danh giấy phép của chúng. Thay thế các hàng bằng các hàng thực tế từ dự án của bạn. Một ghi chú ngắn trong cột cuối cùng nói những gì cần giữ hoặc chia sẻ, và bạn kiểm tra nó đối chiếu với văn bản giấy phép. Các tên, phiên bản và giấy phép ở đây chỉ là ví dụ, và một danh mục thực tế có một hàng cho mỗi phụ thuộc.

Hướng dẫn từng bước: đọc giấy phép, thêm tiêu đề, chạy các bài kiểm thử, xem xét

Khám phá mã và tìm các tệp giấy phép

Bạn bắt đầu với list_dir để xem cấu trúc thư mục và glob để tìm LICENSE, COPYING và các tệp phụ thuộc, sau đó grep tìm kiếm các tệp nguồn cho các dòng SPDX. Phần mềm nguồn mở miễn phí bình thường nêu rõ giấy phép của nó ở 3 nơi này, vì vậy tìm kiếm hiển thị những gì mỗi tệp tuyên bố và những tệp nào không tuyên bố gì. Những người bảo trì một ứng dụng học tập nguồn mở thường liệt kê các tính năng muốn có tiếp theo trong các vấn đề của họ, vì vậy hãy đọc những điều đó trước khi chọn một nhiệm vụ. Đọc, không chỉnh sửa. Mỗi kết quả là một thẻ bạn có thể mở rộng, và vào cuối bước này, bạn có một danh sách các tệp và giấy phép để kiểm tra, mà bạn xem xét cẩn thận trước khi chuyển sang bước tiếp theo. Lưu các ghi chú của bạn vào một tệp văn bản để bạn có thể quay lại chúng sau.

Đọc giấy phép và các quy tắc đóng góp

Bây giờ read_file mở tệp LICENSE và tệp CONTRIBUTING. Giấy phép cho bạn biết những gì bạn có thể làm với mã, và các quy tắc đóng góp cho bạn biết dự án muốn các thay đổi được gửi như thế nào, vì vậy hãy đọc cả hai hoàn toàn. Đóng góp nguồn mở đầu tiên của bạn dễ được chấp nhận hơn khi nó tuân thủ chính xác các quy tắc đó, vì vậy hãy ghi chúng lại. Một số người đóng góp hỏi liệu có nên chia sẻ lịch sử phiên lập trình AI của họ trong công việc nguồn mở hay không; chính sách của dự án về các thay đổi được hỗ trợ bởi AI trả lời điều đó, và nó có thể yêu cầu bạn nói rằng một công cụ đã giúp đỡ. Chạy các bài kiểm thử riêng của dự án một lần trước khi thay đổi bất cứ điều gì, để bạn biết kết quả bắt đầu. Sau đó, xem lại các ghi chú của bạn và ghi lại các quy tắc áp dụng cho thay đổi của bạn. Đọc quy tắc ứng xử, nếu dự án có một quy tắc, vì nó nói về hành vi được mong đợi.

Thêm tiêu đề mà dự án yêu cầu

Một số dự án yêu cầu một tiêu đề giấy phép ngắn, ví dụ một dòng SPDX, ở đầu mỗi tệp mới. Chỉ khi tệp CONTRIBUTING hoặc LICENSE nói như vậy, bạn sử dụng edit_file để thêm chính xác tiêu đề đó vào 3 tệp mới của bạn, và trong Ask first, agent hiển thị một diff trước khi bất cứ điều gì được ghi. Hãy giữ mọi thông báo bản quyền hiện có và không bao giờ thay đổi một giấy phép. Xem xét diff từng dòng. Sau đó sử dụng grep để liệt kê các tệp vẫn thiếu tiêu đề và chạy lệnh kiểm thử của dự án, vì mã thoát cho bạn biết liệu lệnh đã kết thúc mà không có lỗi hay không. Nếu một bài kiểm thử thất bại, hãy đọc kết xuất trước khi thay đổi bất cứ điều gì khác, và hỏi dự án khi một quy tắc tiêu đề không rõ ràng. Sử dụng cùng một dòng tiêu đề trong mỗi tệp.

Kiểm tra kết quả trước khi gửi nó

Cuối cùng, grep hiển thị các tệp nào thiếu tiêu đề, Shell chạy lại các bài kiểm thử và báo cáo mã thoát, và bạn đọc lại toàn bộ diff một lần nữa. Đây là 3 kết quả để so sánh. Một lệnh quét lỗ hổng mã nguồn mà bạn cung cấp cũng có thể chạy thông qua Shell; agent hiển thị kết xuất của nó và bạn quyết định ý nghĩa của nó, nhưng neither quét nor agent đảm bảo rằng không có gì khác sai. Viết mô tả yêu cầu kéo, đề cập đến giấy phép bạn đã kiểm tra và các bài kiểm thử bạn đã chạy, và tự gửi nó. Làm theo các quy tắc của dự án. Người xem xét có thể yêu cầu các thay đổi, và bạn trả lời chúng theo cách tương tự: một bước nhỏ, một diff, một bài kiểm thử. Chờ câu trả lời của họ trước khi thay đổi thêm. Cảm ơn người xem xét khi họ giúp đỡ, và giữ mọi câu trả lời ngắn gọn và lịch sự, một lần sửa mỗi lần.

LibrePatch cho Windows

Bắt đầu quy trình giấy phép đầu tiên của bạn

Tải xuống LibrePatch ↗