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 community health files #37

Open
7 tasks
theamarks opened this issue Nov 25, 2024 · 0 comments
Open
7 tasks

Add community health files #37

theamarks opened this issue Nov 25, 2024 · 0 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation 🏛️ Organize file, folder, directory, architecture

Comments

@theamarks
Copy link
Member

theamarks commented Nov 25, 2024

Problem/Observation

Need clear guidelines for what repo contain, how they are used, and how others can use them. Not clear to users how to cite model, model versions, or model branches that they might use.

Proposed Solution

See here for Github Doc about Community Health Files

  • Add a CITATION.cff file to the root directory that will populate a citation section in the right hand side bar
    • Add note to explain that adjusting the URL or branch or commit hash when appropriate
    • File could be automatically be updated when new released.
  • Add CONTRIBUTING.md file - use DataOne as template
  • Add CODE_OF_CONDUCT.md
  • Add FUNDING.yml
  • Add CC license tag (figure out which one is appropriate)

Example CITATION.cff file

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"

Alternatives Considered

DOI badge, but not that clear

Additional Context

Add any other context or screenshots about the feature request here.

@theamarks theamarks added 📖 documentation Improvements or additions to documentation 🏛️ Organize file, folder, directory, architecture labels Nov 25, 2024
@theamarks theamarks self-assigned this Nov 25, 2024
@theamarks theamarks changed the title Add CITATION.cff file Add community health files Nov 25, 2024
@theamarks theamarks moved this to 🏷 Ready in ARTIS Maintence & Analysis Nov 25, 2024
@theamarks theamarks added this to the ARTIS v2.0 development milestone Nov 25, 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 🏛️ Organize file, folder, directory, architecture
Projects
Status: 🏷 Ready
Development

No branches or pull requests

1 participant