deploy: 8229e73

Author: tkoyama010

.doctrees/TRANSLATING.doctree

@@ -130,13 +130,42 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include
 
 ## What about software citation?
 
-While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using Zenodo.
+While many permissive licenses do not require citation, we strongly encourage that you cite all software that you use in papers, blogs, and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).
 
-<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
+### Citation.cff files: Making your software citable
 
-These files - we need to understand if that date releases auto populates or forces zenodo to modify it's citation. If it's not dynamic it could be problematic
+A `CITATION.cff` file is a machine-readable file that provides citation information for your software package. The "cff" stands for "Citation File Format," which is a standardized format for software citation metadata.
 
--->
+#### What citation.cff files add to your repository
+
+When you add a `CITATION.cff` file to your repository, GitHub automatically detects it and displays a "Cite this repository" button. This makes it easy for users to properly cite your software. The file contains standardized citation information that tools and services can automatically read and use. GitHub will generate both APA and BibTeX citation formats for users.
+
+#### How dates are tracked in citation.cff files
+
+The citation file tracks important dates for your software. The `date-released` field shows when the current version was released. The `date-published` field shows when the software was first made available. You also include a `version` field with the specific version number.
+
+You should update these dates with each new release so people cite the correct version of your software.
+
+#### Integration with Zenodo
+
+Citation.cff files work well with Zenodo, which is a popular place to store research software and get DOIs. When you create a Zenodo release, it can automatically pull information from your citation file. This keeps your citation information the same between GitHub and Zenodo. You can also include your Zenodo DOI in the citation file. Each time you make a new GitHub release, it can create a new Zenodo version with updated citation information.
+
+
+Here's a basic example of what a `CITATION.cff` file might look like:
+
+```yaml
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: "Your Last Name"
+    given-names: "Your First Name"
+    orcid: "https://orcid.org/0000-0000-0000-0000"
+title: "Your Package Name"
+version: 1.0.0
+doi: "10.5281/zenodo.1234"
+date-released: 2025-07-12
+url: "https://github.com/yourusername/your-package"
+```
 
 # References
 

.doctrees/documentation/repository-files/license-files.doctree

@@ -699,12 +699,38 @@ <h2>Important: make sure that you closely follow the guidelines outlines by the
 </section>
 <section id="what-about-software-citation">
 <h2>What about software citation?<a class="headerlink" href="#what-about-software-citation" title="Link to this heading">#</a></h2>
-<p>While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a <a class="reference external" href="https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files">citation.cff file</a>. We will cover this topic when we talk about creating DOI’s for your package using Zenodo.</p>
-<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
-
-These files - we need to understand if that date releases auto populates or forces zenodo to modify it's citation. If it's not dynamic it could be problematic
-
--->
+<p>While many permissive licenses do not require citation, we strongly encourage that you cite all software that you use in papers, blogs, and other publications. You tell your users how to cite your package by using a <a class="reference external" href="https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files">citation.cff file</a>.</p>
+<section id="citation-cff-files-making-your-software-citable">
+<h3>Citation.cff files: Making your software citable<a class="headerlink" href="#citation-cff-files-making-your-software-citable" title="Link to this heading">#</a></h3>
+<p>A <code class="docutils literal notranslate"><span class="pre">CITATION.cff</span></code> file is a machine-readable file that provides citation information for your software package. The “cff” stands for “Citation File Format,” which is a standardized format for software citation metadata.</p>
+<section id="what-citation-cff-files-add-to-your-repository">
+<h4>What citation.cff files add to your repository<a class="headerlink" href="#what-citation-cff-files-add-to-your-repository" title="Link to this heading">#</a></h4>
+<p>When you add a <code class="docutils literal notranslate"><span class="pre">CITATION.cff</span></code> file to your repository, GitHub automatically detects it and displays a “Cite this repository” button. This makes it easy for users to properly cite your software. The file contains standardized citation information that tools and services can automatically read and use. GitHub will generate both APA and BibTeX citation formats for users.</p>
+</section>
+<section id="how-dates-are-tracked-in-citation-cff-files">
+<h4>How dates are tracked in citation.cff files<a class="headerlink" href="#how-dates-are-tracked-in-citation-cff-files" title="Link to this heading">#</a></h4>
+<p>The citation file tracks important dates for your software. The <code class="docutils literal notranslate"><span class="pre">date-released</span></code> field shows when the current version was released. The <code class="docutils literal notranslate"><span class="pre">date-published</span></code> field shows when the software was first made available. You also include a <code class="docutils literal notranslate"><span class="pre">version</span></code> field with the specific version number.</p>
+<p>You should update these dates with each new release so people cite the correct version of your software.</p>
+</section>
+<section id="integration-with-zenodo">
+<h4>Integration with Zenodo<a class="headerlink" href="#integration-with-zenodo" title="Link to this heading">#</a></h4>
+<p>Citation.cff files work well with Zenodo, which is a popular place to store research software and get DOIs. When you create a Zenodo release, it can automatically pull information from your citation file. This keeps your citation information the same between GitHub and Zenodo. You can also include your Zenodo DOI in the citation file. Each time you make a new GitHub release, it can create a new Zenodo version with updated citation information.</p>
+<p>Here’s a basic example of what a <code class="docutils literal notranslate"><span class="pre">CITATION.cff</span></code> file might look like:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">cff-version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.2.0</span>
+<span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;If</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">use</span><span class="nv"> </span><span class="s">this</span><span class="nv"> </span><span class="s">software,</span><span class="nv"> </span><span class="s">please</span><span class="nv"> </span><span class="s">cite</span><span class="nv"> </span><span class="s">it</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">below.&quot;</span>
+<span class="nt">authors</span><span class="p">:</span>
+<span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">family-names</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Your</span><span class="nv"> </span><span class="s">Last</span><span class="nv"> </span><span class="s">Name&quot;</span>
+<span class="w">    </span><span class="nt">given-names</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Your</span><span class="nv"> </span><span class="s">First</span><span class="nv"> </span><span class="s">Name&quot;</span>
+<span class="w">    </span><span class="nt">orcid</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://orcid.org/0000-0000-0000-0000&quot;</span>
+<span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Your</span><span class="nv"> </span><span class="s">Package</span><span class="nv"> </span><span class="s">Name&quot;</span>
+<span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.0.0</span>
+<span class="nt">doi</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;10.5281/zenodo.1234&quot;</span>
+<span class="nt">date-released</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2025-07-12</span>
+<span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://github.com/yourusername/your-package&quot;</span>
+</pre></div>
+</div>
+</section>
+</section>
 </section>
 </section>
 <section id="references">
@@ -787,7 +813,15 @@ <h1>References<a class="headerlink" href="#references" title="Link to this headi
 </ul>
 </li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#important-make-sure-that-you-closely-follow-the-guidelines-outlines-by-the-license-that-you-chose">Important: make sure that you closely follow the guidelines outlines by the License that you chose</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-about-software-citation">What about software citation?</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-about-software-citation">What about software citation?</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#citation-cff-files-making-your-software-citable">Citation.cff files: Making your software citable</a><ul class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#what-citation-cff-files-add-to-your-repository">What citation.cff files add to your repository</a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#how-dates-are-tracked-in-citation-cff-files">How dates are tracked in citation.cff files</a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#integration-with-zenodo">Integration with Zenodo</a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#references">References</a></li>