تخطَّ إلى المحتوى

مولّد استشهادات GitHub

الصق عنوان مستودع على GitHub لتحصل على استشهاد بالبرنامج بنمط APA 7 وMLA 9 وChicago 18، إضافةً إلى مدخلات BibTeX وbiblatex. تقرأ الأداة ملف CITATION.cff الخاص بالمستودع عندما يكون موجودًا، بما في ذلك معرّف DOI من Zenodo وأي عمل يطلب المؤلفون الاستشهاد به بدلًا منه، وتقرأ تفاصيل المستودع من GitHub عندما لا يوجد الملف. كل حقل يبقى قابلًا للتحرير. مجاني، ولا حاجة للتسجيل.

تفاصيل البرنامج

تقرأ الأداة التفاصيل العامة للمستودع من واجهة GitHub البرمجية، وملف CITATION.cff الخاص به إن وُجد. ولا يُرسل إلى GitHub إلا عنوان المستودع.

الأشخاص بصيغة First Last أو Last, First. تبقى المجموعة مثل The pandas development team كما هي؛ وضع اسم أي مجموعة أخرى بين أقواس معقوفة: {Mozilla}.

كما يكتبه المطورون تمامًا، مع الأحرف الكبيرة.

تاريخ النسخة التي استخدمتها. اتركه فارغًا إذا لم يكن هناك تاريخ.

GitHub للمستودع، وZenodo أو أرشيف آخر عندما يكون للإصدار معرّف DOI هناك.

استشهاداتك

ابحث عن مستودع، أو أدخل اسم البرنامج، لترى استشهاداتك.

كيفية استخدام مولّد استشهادات GitHub

  1. 1. الصق عنوان المستودع واضغط ابحث. أي صيغة تصلح: https://github.com/owner/repository، أو رابط إلى ملف داخله، أو owner/repository وحدها.
  2. 2. تحقّق مما مُلئ. من ملف CITATION.cff تحصل على المؤلفين والعنوان والإصدار وتاريخ الإصدار ومعرّف DOI الذي اختاره المطورون. وبدونه لا تعرف GitHub إلا اسم الحساب وآخر إصدار، فأضف المؤلفين الحقيقيين إذا كان المشروع يذكرهم.
  3. 3. احتفظ بمعرّف DOI. عندما يكون الإصدار مؤرشفًا على Zenodo أو مستودع آخر، فإن معرّف DOI الخاص به دائم، وكل نمط يفضّله على عنوان GitHub.
  4. 4. انسخ استشهاداتك. إذا كان ملف CITATION.cff يسمّي ورقة بحثية يُستشهد بها، فإن استشهاداتها تظهر بعد استشهادات البرنامج، إذ يطلب كثير من المشاريع الاثنين معًا.

ما الذي يقدّمه ملف CITATION.cff

ملف CITATION.cff ملف YAML صغير في جذر المستودع يبيّن كيف يُستشهد بالبرنامج، وفق Citation File Format (الإصدار 1.2.0). يقرؤه GitHub ليعرض زر «Cite this repository» مع APA وBibTeX، وتقرأ هذه الأداة المفاتيح نفسها:

مفتاح CITATION.cffما يحتويهأين يذهب
authorsأشخاص (family-names، given-names) أو مجموعة (name)عنصر المؤلف
titleاسم البرنامجعنوان مائل، مع الاحتفاظ بالأحرف الكبيرة كما كُتبت
version, date-releasedالإصدار الذي تستشهد بهالإصدار والتاريخ
doi, identifiersمعرّف DOI، غالبًا من Zenodoالرابط، ويُفضَّل على عنوان URL
repository-codeعنوان المستودععنوان URL عند عدم وجود DOI
preferred-citationورقة بحثية أو عمل آخر يُستشهد به بدلًا منهمجموعة ثانية من الاستشهادات

الاستشهاد بالبرامج بنمط APA وMLA وChicago

APA 7 (§10.10) يستشهد بالبرامج مع إصدارها بين قوسين، والوصف [Computer software] بعد العنوان، ثم الناشر ومعرّف DOI أو عنوان URL. لا يقدّم APA مثالًا على GitHub، لذلك يكون GitHub هو الناشر ما لم يُؤرشف الإصدار في مكان آخر. MLA 9 يبني المدخل من عناصره الأساسية، ويعامل مقالة مركز أسلوب MLA عن الاستشهاد بالكود المصدري مالكَ المستودع بوصفه المؤلف، ويُبقي الأحرف الكبيرة في اسم البرنامج كما هي، ويذكر الإصدار، ويجعل GitHub حاوية ثانية قبل عنوان URL. Chicago 18 (§14.169) يدرج البرامج في الببليوغرافيا تحت مطوّرها، مع الإصدار والناشر. وفي BibTeX، لا يملك @misc الكلاسيكي حقل إصدار، لذلك يوضع الإصدار في ملاحظة؛ أما biblatex فلديه نوع @software حقيقي.

أمثلة استشهاد من GitHub

مواصفة Citation File Format نفسها، التي يسرد ملف CITATION.cff الخاص بها تسعة مؤلفين، والإصدار 1.2.0، وتاريخ إصدار 9 أغسطس 2021، ومعرّف DOI من Zenodo:

الإصدار السابع من APA

قائمة المراجع:

Druskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S., Willighagen, E., Pérez-Suárez, D., & Konovalov, O. (2021). Citation File Format (Version 1.2.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.5171937

داخل النص:

(Druskat et al., 2021)

الإصدار التاسع من MLA وشيكاغو، الإصدار 18

قائمة الأعمال المُستشهَد بها في MLA:

Druskat, Stephan, et al. Citation File Format. Version 1.2.0, Zenodo, 9 Aug. 2021, https://doi.org/10.5281/zenodo.5171937.

حاشية شيكاغو:

Stephan Druskat et al., Citation File Format, version 1.2.0 (Zenodo, 2021), https://doi.org/10.5281/zenodo.5171937.

ببليوغرافيا شيكاغو:

Druskat, Stephan, Jurriaan H. Spaaks, Neil Chue Hong, et al. Citation File Format. Version 1.2.0. Zenodo, 2021. https://doi.org/10.5281/zenodo.5171937.

biblatex

@software:

@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 الخاص بـ Matplotlib من المستخدمين أن يستشهدوا أيضًا بورقة John D. Hunter لعام 2007. وتُنسّق الأداة هذا الاستشهاد المفضّل كذلك:

استشهاد مفضّل من ملف CITATION.cff

APA 7:

Hunter, J. D. (2007). Matplotlib: A 2D graphics environment. Computing in Science & Engineering, 9(3), 90–95. https://doi.org/10.1109/MCSE.2007.55

BibTeX:

@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}
}

عندما لا يحتوي المستودع على ملف CITATION.cff

بدون ملف CITATION.cff تعتمد الأداة على تفاصيل المستودع العامة في GitHub: اسم المستودع عنوانًا، وحساب المالك مؤلفًا، ووسم آخر إصدار وتاريخه إن وُجد. هذه نقطة انطلاق وليست استشهادًا جاهزًا، فابحث عن المؤلفين في ملف README أو على موقع المشروع، واستشهد بالإصدار الذي استخدمته فعلًا. وبدون تسجيل الدخول تسمح GitHub بـ 60 طلب واجهة برمجية في الساعة من الاتصال الواحد، ويستهلك البحث طلبًا أو طلبين؛ فإذا بلغت الحد تُبيّن لك الأداة موعد إعادة ضبطه، ويمكنك ملء النموذج يدويًا. وإذا كنت تدير المستودع، فإن إضافة ملف CITATION.cff تجعل كل استشهاد به متسقًا، ويغطي مولّد استشهادات البرمجيات والكود البرامج غير الموجودة على GitHub.

أخطاء شائعة

  • استخدام اسم الحساب مؤلفًا. "numpy" اسم حساب، والمؤلفون هم الأشخاص أو الفريق الذي يذكره المشروع.
  • ترك الإصدار. الكود يتغير بين الإصدارات. اذكر الإصدار أو وسم الإصدار أو الالتزام الذي استخدمته.
  • استخدام عنوان GitHub عند وجود DOI. معرّف DOI للإصدار المؤرشف لا ينكسر عندما ينتقل المستودع.
  • تجاهل الاستشهاد المفضّل. إذا طلب المطورون الاستشهاد بورقتهم، فاستشهد بها، وغالبًا إلى جانب البرنامج.
  • "تصحيح" الأحرف الكبيرة في اسم برنامج. pandas وNumPy وscikit-learn تُكتب كما يكتبها مطوروها.

الأسئلة الشائعة

كيف أستشهد بمستودع GitHub بنمط APA 7؟
استشهد به بوصفه برنامجًا: المؤلفون، وسنة الإصدار، واسم البرنامج مائلًا، والإصدار بين قوسين، و[Computer software]، والناشر، ثم الرابط. وإذا لم يكن هناك أرشيف فالناشر هو GitHub والرابط عنوان المستودع، وإذا كان لديك معرّف DOI من Zenodo فالناشر Zenodo والرابط هو DOI. وداخل النص: (Druskat et al., 2021).
ما ملف CITATION.cff؟
ملف YAML نصي بسيط في جذر المستودع يخبر الناس كيف يستشهدون بالبرنامج، وفق Citation File Format. يحتوي على المؤلفين والعنوان والإصدار وتاريخ الإصدار ومعرّف DOI، ويمكن أن يسمّي ورقة بحثية يُستشهد بها بدلًا منه. يحوّله GitHub إلى زر «Cite this repository».
هل أستشهد بالبرنامج أم بالورقة التي تصفه؟
اتبع ما يريده المطورون في ملف CITATION.cff. كثير منهم يطلبون الورقة، وتذكر إرشادات Citation File Format أن البرنامج يستحق الاعتراف به كأي مخرج بحثي آخر، لذلك فالاستشهاد بالاثنين شائع: الورقة للمنهج، والبرنامج للإصدار الذي شغّلته.
كيف أحصل على مدخل BibTeX لمستودع GitHub؟
ابحث هنا وانسخ المدخل: @misc لـ BibTeX الكلاسيكي، مع الإصدار في ملاحظة، أو @software لـ biblatex. يحتفظ الاثنان باسم البرنامج بين قوسين مزدوجين حتى تبقى أحرفه الكبيرة.
هل يحتاج البحث إلى حساب على GitHub؟
لا. تستخدم الأداة واجهة GitHub البرمجية العامة، وتقرأ ملف CITATION.cff من raw.githubusercontent.com مباشرة من متصفحك، ولا ترسل إلا عنوان المستودع. وبدون تسجيل الدخول تسمح GitHub بـ 60 طلب واجهة برمجية في الساعة لكل اتصال، ويستهلك البحث طلبًا أو طلبين.
ماذا لو كان المستودع خاصًا أو على GitLab؟
يقرأ البحث المستودعات العامة على GitHub فقط. وفي أي حالة أخرى اكتب التفاصيل في النموذج، فتُنسّق الاستشهادات بالطريقة نفسها، أو استخدم مولّد استشهادات البرمجيات والكود.

أدوات ذات صلة

المزيد في مولدات التوثيق