Công Cụ Tạo Trích Dẫn GitHub

Trích dẫn của bạn

Hãy tra cứu một kho mã, hoặc nhập tên phần mềm, để xem trích dẫn của bạn.

Cách Sử Dụng Công Cụ Tạo Trích Dẫn GitHub

1. 1. Dán địa chỉ kho mã và nhấn Tra cứu. Mọi dạng đều được chấp nhận: https://github.com/owner/repository, đường dẫn tới một tệp bên trong kho, hoặc chỉ owner/repository.
2. 2. Kiểm tra những gì đã được điền. Từ một tệp CITATION.cff, bạn có các tác giả, tiêu đề, phiên bản, ngày phát hành và DOI do nhà phát triển chọn. Không có tệp này, GitHub chỉ biết tên tài khoản và bản phát hành mới nhất — hãy thêm các tác giả thật nếu dự án có liệt kê họ.
3. 3. Giữ lại DOI. Khi bản phát hành được lưu trữ trên Zenodo hoặc kho lưu trữ khác, DOI của nó là vĩnh viễn và mọi kiểu trích dẫn đều ưu tiên nó hơn địa chỉ GitHub.
4. 4. Sao chép trích dẫn của bạn. Nếu CITATION.cff nêu một bài báo cần trích dẫn, trích dẫn của bài báo đó sẽ xuất hiện sau trích dẫn phần mềm — nhiều dự án yêu cầu cả hai.

Tệp CITATION.cff Cung Cấp Những Gì

CITATION.cff là một tệp YAML ngắn ở thư mục gốc của kho mã, cho biết phần mềm nên được trích dẫn như thế nào theo Citation File Format (phiên bản 1.2.0). GitHub đọc tệp này để hiển thị nút “Cite this repository” với APA và BibTeX, và công cụ này đọc cùng các khóa đó:

Trích Dẫn Phần Mềm trong APA, MLA và Chicago

APA 7 (§10.10) trích dẫn phần mềm kèm phiên bản trong ngoặc đơn và mô tả [Computer software] sau tên, rồi đến nhà xuất bản và DOI hoặc URL. APA không có ví dụ về GitHub, nên GitHub đóng vai trò nhà xuất bản trừ khi bản phát hành được lưu trữ ở nơi khác. MLA 9 xây dựng mục từ các yếu tố cốt lõi của nó, và bài của MLA Style Center về trích dẫn mã nguồn coi chủ sở hữu kho mã là tác giả, giữ nguyên cách viết hoa của phần mềm, ghi phiên bản và đặt GitHub làm vùng chứa thứ hai trước URL. Chicago 18 (§14.169) liệt kê phần mềm dưới tên nhà phát triển trong phần thư mục, kèm phiên bản và nhà xuất bản. Trong BibTeX, @misc cổ điển không có trường phiên bản, nên phiên bản được ghi trong một ghi chú; biblatex có kiểu @software riêng.

Ví Dụ Trích Dẫn GitHub

Chính đặc tả Citation File Format, có CITATION.cff liệt kê chín tác giả, phiên bản 1.2.0, ngày phát hành 9 tháng 8 năm 2021 và một DOI Zenodo:

@software{druskat2021citation,
  author    = {Druskat, Stephan and Spaaks, Jurriaan H. and Chue Hong, Neil and Haines, Robert and Baker, James and Bliven, Spencer and Willighagen, Egon and Pérez-Suárez, David and Konovalov, Olexandr},
  title     = {{Citation File Format}},
  version   = {1.2.0},
  date      = {2021-08-09},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.5171937},
  url       = {https://github.com/citation-file-format/citation-file-format}
}

CITATION.cff của Matplotlib yêu cầu người dùng trích dẫn cả bài báo năm 2007 của John D. Hunter. Công cụ cũng định dạng trích dẫn ưu tiên đó:

@article{hunter2007matplotlib,
  author  = {Hunter, John D.},
  title   = {{Matplotlib: A 2D graphics environment}},
  journal = {Computing in Science \& Engineering},
  volume  = {9},
  number  = {3},
  pages   = {90--95},
  year    = {2007},
  doi     = {10.1109/MCSE.2007.55}
}

Khi Kho Mã Không Có CITATION.cff

Khi không có CITATION.cff, công cụ dựa vào thông tin kho công khai của GitHub: tên kho làm tiêu đề, tài khoản của chủ sở hữu làm tác giả, và thẻ cùng ngày của bản phát hành mới nhất, nếu có. Đó là điểm khởi đầu, không phải một trích dẫn hoàn chỉnh — hãy tìm tác giả trong README hoặc trang web của dự án, và trích dẫn đúng phiên bản bạn đã dùng. Khi không đăng nhập, GitHub cho phép 60 yêu cầu API mỗi giờ từ một kết nối, và một lần tra cứu dùng một hoặc hai yêu cầu; nếu chạm giới hạn, công cụ sẽ cho biết khi nào giới hạn được đặt lại, và bạn có thể điền biểu mẫu bằng tay. Nếu bạn quản lý kho mã, việc thêm một CITATION.cff sẽ làm mọi trích dẫn về nó nhất quán — Công Cụ Tạo Trích Dẫn Phần Mềm & Mã Nguồn bao quát các chương trình không nằm trên GitHub.

Những Lỗi Thường Gặp

• Lấy tên tài khoản làm tác giả. "numpy" là một tài khoản; tác giả là những người hoặc nhóm mà dự án nêu tên.
• Bỏ quên phiên bản. Mã thay đổi giữa các bản phát hành. Hãy ghi phiên bản, thẻ bản phát hành hoặc commit mà bạn đã dùng.
• Dùng địa chỉ GitHub khi có DOI. DOI của một bản phát hành đã lưu trữ không bị hỏng khi kho mã chuyển đi nơi khác.
• Bỏ qua trích dẫn ưu tiên. Nếu nhà phát triển yêu cầu bạn trích dẫn bài báo của họ, hãy trích dẫn — thường là cùng với phần mềm.
• "Chỉnh" chữ hoa trong tên phần mềm. pandas, NumPy và scikit-learn được viết đúng như các nhà phát triển viết chúng.

Câu Hỏi Thường Gặp

Làm thế nào để trích dẫn một kho GitHub theo APA 7?

Trích dẫn nó như phần mềm: các tác giả, năm của bản phát hành, tên in nghiêng, phiên bản trong ngoặc đơn, [Computer software], nhà xuất bản và liên kết. Nếu không có kho lưu trữ, nhà xuất bản là GitHub và liên kết là URL của kho; nếu có DOI Zenodo, nhà xuất bản là Zenodo và liên kết là DOI. Trong văn bản: (Druskat et al., 2021).

CITATION.cff là gì?

Một tệp YAML thuần văn bản ở thư mục gốc của kho mã, cho người khác biết cách trích dẫn phần mềm theo Citation File Format. Tệp liệt kê các tác giả, tiêu đề, phiên bản, ngày phát hành và DOI, và có thể nêu một bài báo cần trích dẫn thay thế. GitHub biến nó thành nút “Cite this repository”.

Nên trích dẫn phần mềm hay bài báo về nó?

Hãy làm theo mong muốn của nhà phát triển trong CITATION.cff. Nhiều người yêu cầu bài báo, và hướng dẫn Citation File Format lưu ý rằng phần mềm xứng đáng được ghi nhận như mọi sản phẩm nghiên cứu khác, nên trích dẫn cả hai là phổ biến — bài báo cho phương pháp, phần mềm cho phiên bản bạn đã chạy.

Làm sao để có một mục BibTeX cho kho GitHub?

Tra cứu tại đây và sao chép mục: @misc cho BibTeX cổ điển, với phiên bản trong một ghi chú, hoặc @software cho biblatex. Cả hai đều giữ tên phần mềm trong dấu ngoặc nhọn kép để chữ hoa được bảo toàn.

Tra cứu có cần tài khoản GitHub không?

Không. Công cụ dùng API công khai của GitHub và đọc tệp CITATION.cff từ raw.githubusercontent.com, trực tiếp từ trình duyệt của bạn, chỉ gửi địa chỉ kho. Khi không đăng nhập, GitHub cho phép 60 yêu cầu API mỗi giờ cho mỗi kết nối, và một lần tra cứu dùng một hoặc hai yêu cầu.

Nếu kho mã là riêng tư hoặc nằm trên GitLab thì sao?

Tra cứu chỉ đọc các kho GitHub công khai. Với mọi trường hợp khác, hãy nhập thông tin vào biểu mẫu — trích dẫn được định dạng giống nhau — hoặc dùng Công Cụ Tạo Trích Dẫn Phần Mềm & Mã Nguồn.