From 22d43e6eec64d6aaec2c6d514aec9ff8a66dc5af Mon Sep 17 00:00:00 2001
From: Matthew Feickert <matthew.feickert@cern.ch>
Date: Sat, 24 Aug 2024 01:59:09 -0500
Subject: [PATCH] docs: Add CITATION.cff Citation File Format file (#248)

* Add Citation File Format file to repo to get repository cite button on GitHub.
   - c.f. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files
* Add CITATION.cff to tbump control.
---
 .zenodo.json |  6 ++++--
 CITATION.cff | 28 ++++++++++++++++++++++++++++
 tbump.toml   |  3 +++
 3 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 CITATION.cff

diff --git a/.zenodo.json b/.zenodo.json
index 9df03f00..4e6d9145 100644
--- a/.zenodo.json
+++ b/.zenodo.json
@@ -1,5 +1,5 @@
 {
-    "description": "small package to get structured data out of Les Houches Event files",
+    "description": "A small package to get structured data out of Les Houches Event files",
     "license": "Apache-2.0",
     "title": "scikit-hep/pylhe: v0.8.0",
     "version": "v0.8.0",
@@ -23,8 +23,10 @@
     ],
     "access_right": "open",
     "keywords": [
+      "lhe",
       "physics",
-      "lhe"
+      "python",
+      "scikit-hep"
     ],
     "related_identifiers": [
         {
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 00000000..dfaabd2c
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,28 @@
+cff-version: 1.2.0
+message: "Please cite the following works when using this software."
+type: software
+authors:
+- family-names: "Heinrich"
+  given-names: "Lukas"
+  orcid: "https://orcid.org/0000-0002-4048-7584"
+  affiliation: "Technical University of Munich"
+- family-names: "Feickert"
+  given-names: "Matthew"
+  orcid: "https://orcid.org/0000-0003-4124-7862"
+  affiliation: "University of Wisconsin-Madison"
+- family-names: "Rodrigues"
+  given-names: "Eduardo"
+  orcid: "https://orcid.org/0000-0003-2846-7625"
+  affiliation: "University of Liverpool"
+title: "pylhe: v0.8.0"
+version: 0.8.0
+doi: 10.5281/zenodo.1217031
+repository-code: "https://github.com/scikit-hep/pylhe/releases/tag/v0.8.0"
+keywords:
+  - lhe
+  - physics
+  - python
+  - scikit-hep
+license: "Apache-2.0"
+abstract: |
+  A small package to get structured data out of Les Houches Event files.
diff --git a/tbump.toml b/tbump.toml
index 5439d915..017e4546 100644
--- a/tbump.toml
+++ b/tbump.toml
@@ -38,6 +38,9 @@ src = "README.md"
 [[file]]
 src = ".zenodo.json"
 
+[[file]]
+src = "CITATION.cff"
+
 [[field]]
 # the name of the field
 name = "candidate"