Would it possible to add a .cff file to the repo so that it can be cited more easily?

Open Beginner friendly
#346 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with GitHub's citation-file guidance linked in the issue and inspect the repository metadata needed for citation. Add a valid .cff file for pyperformance, with the project and author details confirmed from the repository; done means GitHub recognizes it and users can cite the suite.

Written by the indexing model from the issue text.

Description

Hi! I'm in the process of writing a thesis in which I extensively used the pyperformance suite and would like to cite it correctly.
According to Github it's possible to add a .cff file, like this.
I know it's not a priority but it would be very useful. Thanks.

Dominant language
Python
Stars
1k
Forks
203
Avg merge
1h 20m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/pyperformance

All issues in python/pyperformance

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.