Add CITATION.cff

dustalov · Nov 29, 2024 · 38b9bdb · 38b9bdb
1 parent 17cfb7c
commit 38b9bdb
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -97,6 +97,11 @@ jobs:
       with:
         token: ${{ secrets.CODSPEED_TOKEN }}
         run: pytest --codspeed
+    - if: matrix.python-version == '3.13'
+      name: Validate CITATION.cff
+      uses: citation-file-format/[email protected]
+      with:
+        args: "--validate"
   pages:
     if: github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
     environment:

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+title: Evalica
+message: If you use this software, please cite the article from preferred-citation.
+type: software
+authors:
+- family-names: Ustalov
+  given-names: Dmitry
+  orcid: "https://orcid.org/0000-0002-9979-2188"
+license: Apache-2.0
+repository-artifact: https://pypi.org/project/evalica/
+repository-code: https://github.com/dustalov/evalica
+preferred-citation:
+  type: conference-paper
+  authors:
+  - family-names: Ustalov
+    given-names: Dmitry
+    orcid: "https://orcid.org/0000-0002-9979-2188"
+  title: "Reliable, Reproducible, and Really Fast Leaderboards with Evalica"
+  year: 2025
+  conference:
+    name: "31st International Conference on Computational Linguistics"
+    date-start: 2025-01-19
+    date-end: 2025-01-24
+date-released: 2024-07-09