doi-check-app

A GitHub app that checks for DOI links in the README.md file of a repository and warns the user if no DOI is found.

https://github.com/fairdataihub/doi-check-app

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A GitHub app that checks for DOI links in the README.md file of a repository and warns the user if no DOI is found.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 1
Created about 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Codemeta

README.md

Contributors Stargazers Issues MIT License Curated with FAIRshare DOI

DOI Checker GitHub App

A GitHub App built with Probot. This app checks for DOI links in the README.md file of a repository and warns the user if no DOI is found.

Usage

Install the app on the intended repositories. The app can be found here: https://github.com/apps/doi-checker-app

Setup

```sh

Install dependencies

npm install

Run the bot

npm start ```

Docker

```sh

1. Build container

docker build -t doi-check-app .

2. Start container

docker run -e APPID= -e PRIVATEKEY= doi-check-app ```

Contributing

If you have suggestions for how doi-check-app could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

MIT © 2023 fairdataihub

Owner

  • Name: FAIR Data Innovations Hub
  • Login: fairdataihub
  • Kind: organization
  • Email: info@fairdataihub.org
  • Location: United States of America

We build open source tools to help researchers learn about and implement FAIR Data practices

Citation (CITATION.cff)

# This CITATION.cff file was generated with FAIRshare.
# Visit https://fairdataihub.org/fairshare to learn more!

abstract: A GitHub app that checks for DOI links in the README.md file of a repository
  and warns the user if no DOI is found.
authors:
- affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
  email: ssoundarajan@calmi2.org
  family-names: Soundarajan
  given-names: Sanjay
  orcid: 0000-0003-2829-8032
- affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
  email: bpatel@calmi2.org
  family-names: Patel
  given-names: Bhavesh
  orcid: 0000-0002-0307-262X
cff-version: 1.2.0
date-released: '2023-01-30T21:47:50.837Z'
identifiers:
- description: DOI for this software's record on Zenodo
  type: doi
  value: 10.5281/zenodo.7587128
keywords:
- Probot
- Digital Object Identifier
- FAIR
license: MIT
message: If you use this software, please cite it as below.
repository-code: https://github.com/fairdataihub/doi-check-app
title: DOI Checker GitHub App
type: software
url: http://fairdataihub.org
version: 1.0.0

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/MIT",
  "codeRepository": "https://github.com/fairdataihub/doi-check-app",
  "dateCreated": "2023-01-28T09:06:18Z",
  "datePublished": "2023-01-30",
  "dateModified": "2023-01-30T21:47:50.837Z",
  "issueTracker": "https://github.com/fairdataihub/doi-check-app/issues",
  "name": "DOI Checker GitHub App",
  "version": "1.0.0",
  "identifier": "10.5281/zenodo.7587128",
  "description": "A GitHub app that checks for DOI links in the README.md file of a repository and warns the user if no DOI is found.",
  "applicationCategory": "Scientific",
  "releaseNotes": "First release",
  "developmentStatus": "active",
  "isPartOf": "http://fairdataihub.org",
  "keywords": [
    "Probot",
    "Digital Object Identifier",
    "FAIR"
  ],
  "programmingLanguage": [
    "JavaScript",
    "HTML",
    "Shell",
    "Dockerfile"
  ],
  "relatedLink": [
    "https://github.com/apps/doi-checker-app"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0003-2829-8032",
      "givenName": "Sanjay",
      "familyName": "Soundarajan",
      "email": "ssoundarajan@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute"
      }
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-0307-262X",
      "givenName": "Bhavesh",
      "familyName": "Patel",
      "email": "bpatel@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute"
      }
    }
  ]
}

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 18
  • Total Committers: 2
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.222
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Sanjay Soundarajan s****6@l****m 14
Bhavesh Patel b****l@b****u 4
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 6.0
  • Merged pull requests: 0
  • Bot issues: 1
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • doi-checker-app[bot] (1)
Pull Request Authors
  • renovate[bot] (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

Dockerfile docker
  • node 18-slim build
package-lock.json npm
  • 525 dependencies
package.json npm
  • jest ^29.0.0 development
  • nock ^13.0.5 development
  • smee-client ^1.2.2 development
  • probot ^12.2.4
yarn.lock npm
  • 528 dependencies