Skip to content

Add citation.cff and note for citing in README #4472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Add citation.cff and note for citing in README #4472

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c96fa3f
Add citation.cff and note for citing in README #57
chinyeungli Jul 14, 2025
74c4495
Add Ayan's orcid and remove individual author #57
chinyeungli Jul 23, 2025
ab20b92
Update DOI, version, and release date in citation.cff automatically w…
chinyeungli Jul 24, 2025
deaee37
Update workflow to create PR instead of pushing to develop directly #57
chinyeungli Jul 24, 2025
30b0952
Add permission field #57
chinyeungli Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: ScanCode-Toolkit
authors:
- family-names: Philippe
given-names: Ombredanne
orcid: 'https://orcid.org/0000-0001-5280-9256'
- family-names: Ayan
given-names: Sinha Mahapatra
- family-names: Jono
given-names: Yang
- family-names: Georg
given-names: Brandl
- name: 'nexB Inc. and others.'
license: Apache-2.0
url: 'https://github.com/aboutcode-org/scancode-toolkit'
# version: <ToDo>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will the DOI and version/data be automatically added here: #57 (comment)? Which main page are you talking about?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not at the moment. , but I should be able to automate it once the Zenodo concept DOI is available. Since it gets generated after the first (pre-)release after linked to Zenodo, I’ll set up a script to update the CITATION.cff as soon as that DOI is in place.

The approach would be:

  1. Create a pre-release to trigger zenodo to generate a unique DOI
  2. get the DOI and update the CITATION.cff (This could be automate after the DOI is generated in (1))
  3. commit and push the changes (This could be probably automated as well)
  4. make the pre-release to final

# date-released: <ToDo>
# doi: <ToDo>
3 changes: 3 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ Other Important Documentation Pages:

See also https://aboutcode.org for related companion projects and tools.

To cite this repository, visit the main page and click on the 'Cite this
repository' button for APA or BibTeX citation formats.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this button added, will it be there automatically after a release?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you add a CITATION.cff file to the default branch of your repository, a link is automatically added to the repository landing page in the right sidebar, with the label "Cite this repository."

from https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files



Installation
============
Expand Down
Loading