Git cho tài liệu nghiên cứu: điều gì thực sự hiệu quả với đồng tác giả

Các nhà nghiên cứu đã sử dụng Git cho mã. Giấy tờ trông rất giống mã: văn bản thuần túy, bao gồm, xây dựng rác. Đưa một bản thảo vào một repo ít lạ hơn âm thanh một khi bạn đã thử nó một lần.

Bỏ qua những thứ rác rưởi

Một .gitignore hợp lý cho LaTeX:

*.aux
*.log
*.out
*.toc
*.synctex.gz
*.bbl
*.blg
*.fdb_latexmk
*.fls

Cam kết .tex, .bib, những số liệu bạn không thể tạo lại và tệp lớp nếu trường đại học yêu cầu nó. Bỏ qua việc cam kết mọi bản PDF trừ khi tạp chí muốn một tệp nhị phân trong kho lưu trữ.

Nếu trình soạn thảo của bạn khởi động Git cho bạn, hãy kiểm tra xem bộ nhớ đệm bản dựng và PDF trung gian được bỏ qua. Một luồng “tiếng ồn” trống từ các tệp phụ trợ làm cho nhật ký trở nên vô giá trị. Bạn ngừng đọc nó và rồi lịch sử không thể giúp đỡ bạn khi có thứ gì đó bị vỡ.

Tệp riêng, không phải dòng

Hai người cùng đoạn là hợp nhất đau đớn. Thích chương hoặc phần quyền sở hữu. Sử dụng yêu cầu kéo khi nhóm đủ lớn để xem xét thực sự có ích.

Việc gõ trực tiếp nhiều người dùng vào một bộ đệm là một công cụ khác (trình duyệt LaTeX biên tập viên). Cộng tác với Git chậm hơn và rõ ràng hơn: phân nhánh, đẩy, đánh giá. Điều đó hoạt động tốt khi bạn cần một dấu vết giấy tờ. Khi ba người phải gõ cùng nhau trừu tượng chiều nay, chọn cái gì khác.

Cam kết tin nhắn trong tương lai bạn có thể đọc

“Sửa đồ” sẽ vô dụng trong ba tháng. “Viết lại các công việc liên quan đến máy biến thế” là đủ. Hai lớp giúp:

1. Các cột mốc bạn đặt tên: phần nháp, phần nộp, sẵn sàng cho máy ảnh.
2. Điểm kiểm tra an toàn: chụp ảnh nhanh thường xuyên để một buổi chiều tồi tệ có thể đảo ngược.

Nếu trình soạn thảo của bạn kiểm tra điểm sau khi biên dịch thành công hoặc sau khi bạn ngừng nhập, hãy coi chúng như một tầng chứ không phải là lịch sử duy nhất. Viết một tin nhắn thực sự khi một phần đất hoặc bản thảo sẽ được chuyển đến đồng tác giả.

Điều khiển từ xa riêng

Tác phẩm chưa được xuất bản thuộc về các dự án GitHub hoặc GitLab riêng tư. Tốt nghiệp và di chuyển trong phòng thí nghiệm là khi mọi người mất quyền truy cập vào tài khoản biên tập đám mây ngẫu nhiên. Một điều khiển từ xa bạn kiểm soát là bản sao lưu.

Đẩy khi bạn có mạng. Đừng đợi đến đêm trước thời hạn mới làm phát hiện ra điều khiển từ xa chưa bao giờ được kết nối.

Biên dịch cục bộ, sao lưu từ xa

Hầu hết các tuần, vòng lặp trông như thế này: chỉnh sửa và biên dịch ngoại tuyến, đẩy khi bạn có mạng. Bạn không cần phiên trình duyệt trực tiếp chỉ để gõ.

Những gì bạn muốn từ công cụ:

• mọi dự án đều đã là kho lưu trữ Git thực sự (không quên git init)
• điểm kiểm tra tự động sau khi biên dịch thành công và chỉnh sửa nhàn rỗi
• giai đoạn, khác biệt song song, loại bỏ và khôi phục bằng một cú nhấp chuột trong cùng một ứng dụng với trình chỉnh sửa và PDF
• GitHub tùy chọn cho điều khiển từ xa; lịch sử đã hoạt động trên đĩa
• phân nhánh toàn bộ dự án với đầy đủ lịch sử cho một thử nghiệm song song (rủi ro phương pháp viết lại, tiếp tục thay thế) trong khi bản sao gửi vẫn được đặt
• Chỉnh sửa AI, nếu bạn bật chúng, hãy kiểm tra điểm trước và chỉ đi qua sự khác biệt trong phê duyệt

Oleafly được xây dựng để cách: các thư mục đơn giản, .git thực, các điểm kiểm tra tự động đặt tên cho các tệp đã di chuyển, Bảng điều khiển nguồn với các khác biệt của cây làm việc có thể chỉnh sửa, khôi phục sau xác nhận, xuất bản/đẩy/kéo GitHub tùy chọn với phía trước/phía sau, phân nhánh dự án với dòng dõi trong thư viện. Terminal git log khớp với ứng dụng vì nó là cùng một kho lưu trữ. Điểm kiểm tra AI, khi bạn sử dụng một điểm, sẽ dừng ở điểm đó lịch sử bạn khôi phục từ đó.

Bạn có thể ước chừng các phần này bằng thói quen cẩn thận và một Git riêng khách hàng. Sự khác biệt là liệu lịch sử có phải là thứ bạn thiết lập và ghi nhớ hay không, hoặc điều gì đó mà không gian làm việc nghiên cứu đảm nhận vào ngày đầu tiên bên cạnh SyncTeX và biên dịch.

Những gì Git không sửa được

Git sẽ không thay thế nhận xét từ PI chỉ mở tệp PDF và nó sẽ không thay thế quyết định xem tóm tắt của ai là đúng. Số nhị phân vẫn hợp nhất kém, vì vậy hãy giữ chúng nhỏ, thích những mảnh đất bạn có thể tái tạo và đồng ý sớm về quyền sở hữu.

Đối với các đồng tác giả từ chối Git, hãy xuất PDF hoặc DOCX để xem xét và giữ nguyên .tex nguồn sự thật. Xem đồng tác giả chỉ nói Word.

Thực hành tối thiểu

1. Một repo cho mỗi bài báo hoặc luận án, không phải một repo lớn cho toàn bộ sự nghiệp của bạn.
2. .gitignore để xây dựng rác vào ngày đầu tiên.
3. Quyền sở hữu chương khi có nhiều người cùng chỉnh sửa.
4. Cam kết cột mốc với các tin nhắn có thể đọc được.
5. Điều khiển từ xa riêng được kết nối trước khi công việc quan trọng.
6. Khôi phục đã được thử nghiệm một lần có mục đích, vì vậy trường hợp khẩn cấp đầu tiên không phải là trường hợp đầu tiên khôi phục.

Nếu bạn bám vào danh sách đó, Git cho giấy tờ hầu như sẽ biến mất trong nền. Bạn muốn sự tin cậy nhàm chán trước thời hạn chứ không phải sở thích thứ hai.