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 GitHub citation file #132

Open
jmadden173 opened this issue Sep 6, 2024 · 0 comments
Open

Add GitHub citation file #132

jmadden173 opened this issue Sep 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jmadden173
Copy link
Contributor

Describe the Enhancement
Investigate and implement a citation file for the repo that references the first paper in the project. Instructions from GitHub are available here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Benefits
Make the repository easier to cite and create a clear connection between published work and code repository.

Possible Drawbacks
N/A

Additional Context
Most likely will wait until first full length paper is published.

@jmadden173 jmadden173 added the enhancement New feature or request label Sep 6, 2024
@jmadden173 jmadden173 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant