bugGNU Octave - Bugs: bug #62462, [GitHub] Please apply the CFF...

 
 

bug #62462: [GitHub] Please apply the CFF standard to your CITATION file

Submitter:  None
Submitted:  Sat 14 May 2022 05:19:40 PM UTC
 
Category:  Other Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Other
Status:  None Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Open Release:  * dev
Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Mon 16 May 2022 09:14:52 AM UTC, comment #1: 
Markus Mützel <mmuetzel>
Project Member
Sat 14 May 2022 05:19:40 PM UTC, original submission:  

### Detailed Description

GitHub uses the [ruby-cff](https://github.com/citation-file-format/ruby-cff) library in order to parse `CITATION.cff` files.  The library also converts the content to BibTeX entries as well as APA citations.  These conversions are added to the "Cite this repository" text box automatically.

Applying the CFF standard to your `CITATION.cff` would make it, hence, easier to cite your work appropriately.

### Suggested Fix

1. Rename your `CITATION` file `CITATION.cff` such that GitHub can parse it.
2. Comment out your recent lines with `#` at the beginning of each line.
3. Add the lines below to the file.  The lines specify a minimum valid CFF file, you are free to extend the meta data as you like.

```
authors:
  - family-names: Eaton
    given-names: John W.
  - family-names: Bateman
    given-names: David
  - family-names: Hauberg
    given-names: "Søren"
  - family-names: Wehbring
    given-names: Rik
cff-version: 1.2.0
message: We have invested a lot of time and effort in creating GNU Octave, please cite it when using it.
title: GNU Octave

preferred-citation:
  type: manual
  title: "GNU Octave version 7.1.0 manual: a high-level interactive language for numerical computations"
  authors:
    - family-names: Eaton
      given-names: John W.
    - family-names: Bateman
      given-names: David
    - family-names: Hauberg
      given-names: "Søren"
    - family-names: Wehbring
      given-names: Rik
  year: 2022
  url: https://www.gnu.org/software/octave/doc/v7.1.0/
```

### Further Readings

For an introduction to CFF, I recommend https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md, the official guideline how the format works.  Its repository also lists a set of tools you can use to work with your citation file, just take a look at the table in https://github.com/citation-file-format/citation-file-format/blob/main/README.md.

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by mmuetzel (Posted a comment)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only project members can vote.

     

     

     

     

    No changes have been made to this item

    Back to the top


    Powered by Savane 3.9