Merge branch 'main' into repo-sync

Octomerger · web-flow · commit 8e720a7977d1 · 2021-07-23T08:03:21.000+10:00
diff --git a/assets/images/help/repository/citation-link.png b/assets/images/help/repository/citation-link.png
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md
@@ -0,0 +1,43 @@
+---
+title: About CITATION files
+intro: 'You can add a CITATION file to your repository to help users correctly cite your software.'
+versions:
+  fpt: '*'
+  ghes: '>=3.3'
+  ghae: '>=M3'
+topics:
+  - Repositories
+---
+## About CITATION files
+
+You can add a `CITATION.cff` file to the root of a repository to let others know how you would like them to cite your work. The citation file format is plain text with human- and machine-readable citation information. 
+
+Example CITATION.cff:
+```
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: Lisa
+  given-names: Mona
+  orcid: https://orcid.org/0000-0000-0000-0000
+- family-names: Bot
+  given-names: Hew
+  orcid: https://orcid.org/0000-0000-0000-0000
+title: "My Research Software"
+version: 2.0.4
+doi: 10.5281/zenodo.1234
+date-released: 2017-12-18
+url: https://github.com/github/linguist
+```
+
+For more information, see the [Citation File Format](https://citation-file-format.github.io/) website.
+
+When you add a `CITATION.cff` file to the default branch of your repository, it is automatically linked from the repository landing page. This makes it easy for other users to cite your software project, using the information you've provided.
+
+![Citation link on repository landing page](/assets/images/help/repository/citation-link.png)
+
+## Citation formats
+
+We currently support APA and BibTex file formats.
+
+Are you looking for additional citation formats? GitHub uses a Ruby library, to parse the `CITATION.cff` files. You can request additional formats in the [ruby-cff](https://github.com/citation-file-format/ruby-cff) repository, or contribute them yourself.
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md
@@ -15,7 +15,7 @@ topics:
 ---
 ## About READMEs
 
-You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
+You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.1 or ghae-issue-4651 %}, citation file{% endif %}{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
 
 For more information about providing guidelines for your project, see {% ifversion fpt %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
 
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md
@@ -18,6 +18,7 @@ children:
   - /about-code-owners
   - /about-repository-languages
   - /licensing-a-repository
+  - /about-citation-files
   - /creating-a-template-repository
   - /creating-an-issues-only-repository
   - /limits-for-viewing-content-and-diffs-in-a-repository
