Hợp tác hiệu quả, đặc biệt trong phát triển phần mềm open source, bắt đầu từ tổ chức hiệu quả. Để đảm bảo không bỏ lỡ gì, quy tắc chung "một issue, một pull request" là ngón tay cái hay.
Thay vì mở issue phạm vi lớn như "Sửa tất cả broken link trong tài liệu", dự án open source sẽ thu hút contributor hơn với nhiều issue nhỏ, dễ quản lý hơn.
Trong ví dụ trước, bạn có thể chia broken link theo section hoặc theo trang. Điều này cho phép nhiều contributor tham gia và dành cửa sổ thời gian nhỏ, thay vì chờ một người gánh vác nỗ lực contribution lớn và nhàm chán.
Issue phạm vi nhỏ cũng giúp maintainer thấy đâu đã xong, đâu chưa. Giảm nguy cơ bỏ sót phần nào của issue, cho là xong, sau này dẫn đến bug hoặc lỗ hổng bảo mật.
Đó đều tốt. Nhưng nếu bạn đã mở vài issue quy mô lớn, một số PR đã submit hoặc merge, và hiện không biết công việc bắt đầu/kết thúc đâu?
Sẽ cần chút sắp xếp để đưa trạng thái dự án trở lại kiểm soát. May mắn là có nhiều công cụ dòng lệnh giúp quét, sắp xếp, và hiểu repository rối rắm. Dưới đây là một vài công cụ tôi dùng.
Tìm và thay thế tương tác với vim
Bạn có thể mở file trong Vim, sau đó tìm và thay thế tương tác bằng:
:%s/\<word\>/newword/gc
% chỉ tìm trong tất cả dòng file hiện tại, s là substitute, \<word\> khớp toàn bộ từ, và g cho "global" là mọi occurrence. c ở cuối cho xem và xác nhận mỗi thay đổi trước khi làm. Có thể chạy tự động, nhanh hơn, không c, nhưng rủi ro phức tạp hóa nếu pattern-matching sai.
Tìm dead link trong file Markdown với node module
Node module markdown-link-check có CLI buddy tuyệt vời.
Tôi dùng thường nên biến thành Bash alias function. Để làm tương tự, thêm vào .bashrc:
# Markdown link check in a folder, recursive
function mlc () {
find $1 -name \*.md -exec markdown-link-check -p {} \;
}
Sau đó chạy với mlc <filename>.
Liệt kê subdirectory có hoặc không có git repository với find
In tất cả subdirectory là git repository, nghĩa là có .git trong đó:
find . -maxdepth 1 -type d -exec test -e '{}/.git' ';' -printf "is git repo: %p\n"
Để in tất cả subdirectory không phải git repository, phủ định test với !:
find . -maxdepth 1 -type d -exec test '!' -e '{}/.git' ';' -printf "not git repo: %p\n"
Pull nhiều git repository từ danh sách với xargs
Tôi dùng này ban đầu như một phần tự động tái tạo laptop với Bash script, nhưng khá tiện khi làm việc với cloud instance hoặc Dockerfile.
Cho file repos.txt với SSH link repository trên mỗi dòng (và SSH keys đã setup), chạy:
xargs -n1 git clone < repos.txt
Nếu muốn pull và push nhiều repository, tôi trước đây viết về cách dùng Bash one-liner quản lý repository.
Liệt kê issue theo số với jot
Tôi là co-author và maintainer cho repository OWASP Web Security Testing Guide, nơi gần đây tôi lấy một issue lớn (vâng, đúng là "Sửa tất cả broken link trong tài liệu" - bạn đoán sao?) và chia thành vài issue nhỏ, dễ quản lý hơn. Trên hết ba mươi bảy issue nhỏ.
Tôi muốn liệt kê tất cả issue từ issue gốc, nhưng gõ ba mươi bảy số issue (#275 đến #312) nghe nhàm chán và tốn thời gian. Vì vậy, theo phong cách lập trình viên tự nhiên, tôi dành cùng thời gian gõ số đó để tự động hóa thay vào đó.
Tiện ích jot (apt install athena-jot) là công cụ nhỏ giúp lớn khi muốn in một dãy số. Chỉ nói muốn bao nhiêu, bắt đầu và kết thúc ở đâu.
# jot [ reps [ begin [ end ] ] ]
jot 37 275 312
Lệnh này in từng số, bao gồm cả hai đầu, từ 275 đến 312 trên dòng mới. Để biến thành ký hiệu issue number mà GitHub và nhiều platform khác tự nhận diện và biến thành link, pipe output sang awk.
jot 37 275 312 | awk '{printf "#"$0", "}'
#275, #276, #277, #278, #279, #280, #281, #282, #283, #284, #285, #286, #287, #288, #289, #290, #291, #292, #293, #295, #296, #297, #298, #299, #300, #301, #302, #303, #304, #305, #306, #307, #308, #309, #310, #311, #312
Bạn cũng có thể dùng jot tạo dữ liệu ngẫu nhiên hoặc lặp lại, chủ yếu cho dev hoặc test.
Tổ chức open source bằng CLI
Repository open source tổ chức tốt là dự án open source maintain tốt. Lưu bài này để tham khảo, và dùng siêu năng lực CLI mới cho điều tốt!