Skip to content
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.

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

Add CITATION.cff #891

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from
135 changes: 135 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
cff-version: 1.2.0
message: "If you use this software, please cite it using the metadata from this file."
ShadowMitia marked this conversation as resolved.
Show resolved Hide resolved

# Citation information, which will be used for Github display
# and for differnt file formats like BibTex
title: "The Arcane Algorithm Archive"
date-released: 2017-01-11
url: "https://algorithm-archive.org/"
repository-code: "https://github.com/algorithm-archivists/algorithm-archive"
license: MIT
license-url: https://github.com/algorithm-archivists/algorithm-archive/blob/master/LICENSE.md
keywords:
- "algorithms"
- "language agnostic"
- "collection of algorithms"
- "open research"
- "data structures"
- "collection of data structures"
type: software
Copy link
Member

Choose a reason for hiding this comment

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

Are there other types? I don't know if software is right, but it's also not wrong

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So this is where the file format gets a bit weird. Apparently it assumes the repo is either for "software" or "dataset". These are the only allowed types at that level of the file.

In the "references" you can have way more types, but it's just things that reference this file I guess? So I've been assuming that we're talking about the code for the website (which you can think of as a software you can run on your machine as well), but I agree it's not the best thing.

commit: 16fd2180041821f8ee53ece14c535e5b25de34fe
Copy link
Member

Choose a reason for hiding this comment

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

This essentially counts as a release for citations, right? That is to say that when people cite this work, they will be citing this, specific commit?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I was just trying something out. I thought that the file required a "version" to be attached, but it wasn't. But I was thinking maybe it made sense to be able to cite the website when it was in a specific state?

Copy link
Member

Choose a reason for hiding this comment

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

I would think we should omit this for now

Copy link
Member

Choose a reason for hiding this comment

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

I think it might be a good idea to tie this to a certain release (Maybe V 0.2021.1)? That way if people do cite this work, they can easily find the correct version. I also think zenodo links will usually be related to a specific release anyway, right?

Copy link
Member

Choose a reason for hiding this comment

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

I also think zenodo links will usually be related to a specific release anyway, right?

Correct.


# To add a new author properly
# see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson
# Check also the following list if in doubt

# To add only an author as a pseudonym only, using `name` works best
# othersiwise just use `alias` to have both name and pseudonym
#

authors:
- family-names: Schloss
given-names: James
alias: Leios
orcid: "https://orcid.org/0000-0002-3243-8918"
- family-names: Mazzuca
given-names: Nicole
Copy link
Member

Choose a reason for hiding this comment

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

I know Nicole said they do not want to be officially part of this project, due to some philosophical differences with how we write idiomatic C++ code

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If they provided code or help for other things they still should be here 😁 (If they want)

- family-names: Becker
given-names: Marius
- name: Gathros
- family-names: Gillet
given-names: Jeremie
alias: (- Jie -)
ShadowMitia marked this conversation as resolved.
Show resolved Hide resolved
- family-names: Khatib
given-names: Salim
- family-names: C
given-names: Hitesh
- name: Shaurya
- family-names: Dherbécourt
given-names: Maxime
- name: Jess 3Jane
- name: Pen Pal
- family-names: Mahesh
given-names: Chinmaya
- name: Unlambder
- family-names: Johannessen
given-names: Kjetil
- name: CDsigma
- name: Gammison
- name: hsjoihs
- name: DominikRafacz
- name: lulucca12
- name: GuyPozner
- family-names: Boyles
given-names: William
- family-names: Weinstein
given-names: Max
Copy link
Member

Choose a reason for hiding this comment

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

How do we organize all of these names?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's definitely going to be a big mess 😅

- name: Gibus Wearing Brony
- name: Gorzoid
- family-names: Sahadeo
given-names: Arun
- name: NIFR91
- family-names: Hanajik
given-names: Michal
- family-names: Samseth
given-names: Bendik
- name: mukundan314
- name: Trashtalk
- family-names: Burt
given-names: Cyrus
- family-names: Power
given-names: Ken
- name: PaddyKe
- name: nic-hartley
- family-names: Raymakers
given-names: Thijs
- name: crafter312
- family-names: Milan
given-names: Christopher
- name: Vexatos
- name: Raven-Blue Dragon
- family-names: Heinrichs
given-names: Björn
- family-names: Sundfør
given-names: Olav
- family-names: Chislett
given-names: Ben
- name: dovisutu
- name: Antetokounpo
- family-names: Dhiman
given-names: Akash
- family-names: Zalzal
given-names: Vincent
- family-names: Schenck
name-particle: Van
given-names: Jonathan D B
- family-names: Goytia
given-names: James
- name: Amaras
ShadowMitia marked this conversation as resolved.
Show resolved Hide resolved
- family-names: Dönszelmann
given-names: Jonathan
- family-names: Verma
given-names: Ishaan
- name: Delphi1024
- name: ntindle
ShadowMitia marked this conversation as resolved.
Show resolved Hide resolved
- family-names: Sarikhani
given-names: Mahdi
- name: Ridham177
- family-names: Salou
given-names: Hugo
- family-names: Belopopsky
given-names: Dimitri
alias: ShadowMitia
# - name: "The Arcane Algorithm Archive Contributors"
# website: "https://github.com/algorithm-archivists/algorithm-archive/blob/master/CONTRIBUTORS.md"

# Add more references to the citation
references:
- type: website
authors:
- family-names: Schloss
given-names: James
alias: Leios
title: The Arcane Algorithm Archive
url: https://www.algorithm-archive.org/