[Documentation] CFF

[kevinmatthes]

CFF is a community standard GitHub applies in order to show a "Cite this repository" button on the welcome page. This enables visitors to cite the repositories which provide such a file in their papers and theses, contributors to log relevant further readings, and maintainers to show who has helped the project to grow.

This thread is intended to discuss

• whether to cite at all,
• if so, which information shall be provided, and
• if the automatic correctness check for the CFF shall be set up.

[kevinmatthes]

Whether to cite at all?

[kevinmatthes]

In my opinion, every repository should be citable in order to be able to name it in a unified way all contributors have agreed on.

This repository in particular definitely should be citable since it contains many interesting algorithmic ideas that could be researched in papers. But also when working with the editor -- since it can be extended with further and also rare languages --, it is easier to name it as a helpful tool in a list of references.

[kevinmatthes]

Which information should be provided?

[kevinmatthes]

Despite the absolutely minimum of information, I would like to suggest to include the following:

• date-released
• version
• abstract
• license
• repository-code (this repository)
• repository-artifact (description on crates.io)
• url (this project's website)
• references

For the authors section, I would like to suggest to name all contributors to this repository at least with their GitHub identifiers (alias) as well as the community (name; example: name: The Zee Community) to include all people who outlined bugs, request new and interesting features, and participated on constructive discussions and thereby helped to grow this project.

The preferred-citation is optional in case the citation is intended to be something other than software, for instance a paper about this editor.

Contributors should be free to add further readings for their Pull Requests as references.

[kevinmatthes]

Should the GitHub Action be set up for this repository?

[kevinmatthes]

Yes, it should, I think.

Setting it up is really simple, I have prepared a template therefore which I would adjust for this repository by adding a corresponding section for Pull Requests.

[kevinmatthes]

I just suggested an initial setup in #69. I am looking forward for your feedback.