Data

Tools

Indexes

Applications

Experiments

Open Source Science

codefair-app

Your coding assistant to make research software reusable without breaking a sweat!

https://github.com/fairdataihub/codefair-app

Science Score: 49.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 7 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.5%) to scientific vocabulary

Keywords

best-practices fair research reusable software
Last synced: 6 months ago · JSON representation

Repository

Your coding assistant to make research software reusable without breaking a sweat!

Basic Info
  • Host: GitHub
  • Owner: fairdataihub
  • License: mit
  • Language: Vue
  • Default Branch: main
  • Homepage: https://codefair.io
  • Size: 38.1 MB
Statistics
  • Stars: 9
  • Watchers: 1
  • Forks: 2
  • Open Issues: 11
  • Releases: 7
Topics
best-practices fair research reusable software
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Codemeta

README.md

logo

Codefair

Your coding assistant to make research software reusable without breaking a sweat!


Get the app »

Learn more »

contributors stars open issues license Zenodo DOI Software Heritage archive


Codefair Live Status

View the live status of Codefair at status.codefair.io. You can check the status of the app, including any incidents or outages that may affect its performance. The status page provides real-time updates on the app's availability and performance, ensuring that you are always informed about its current state.

Description

Codefair is your personal assistant when it comes to making your research software reusable and especially complying with the Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software. Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, Codefair is here to assist you. By communicating with you through GitHub issues and submitting pull requests, Codefair will make sure that your software follows best coding practices, provides metadata in standard format, includes a license file, is archived on Zenodo, and much more. With Codefair by your side, you're not just developing software but you're advocating for better software practices. Learn more on the app's website codefair.io.

screenshot of the License issue up to where is it closed with the PR

Getting started

Installing

  1. Install Codefair from the GitHub market place on the GitHub organizations or repositories of your choice
  2. Code as usual
  3. Track FAIR compliance issues through the Codefair issue dashboard and address them through the Codefair website.

[!NOTE] While Codefair is free, installing it via the GitHub Marketplace may still require a credit card to be associated with your (or your organization’s) GitHub account. To circumvent this requirement, you can alternatively install Codefair directly from the app page.

Documentation

See our dedicated webpage for full details on what permissions are used and the features Codefair provides.

Run the GitHub app locally

For detailed instructions on setting up running the application locally, please refer to our documentation site.

How Codefair is developed

Codefair is developed using Probot and is deployed on a server as a serverless function. The GitHub app is configured to receive webhooks for important actions such as pushing code, opening or closing issues, opening or merging pull requests and commenting on discussions. By leveraging a serverless environment on a server, Codefair can automatically scale to handle the workload of the GitHub app. The app is written in Node.js and utilizes the Octokit library to interact with the GitHub API enabling seamless integration with GitHub's features and functionality.

Contributing

Contributions are always welcome!

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Issues and Feedback

To report any issues with the software, suggest improvements, or request a new feature, please open a new issue via the Issues tab. Alternatively, you can also use our contact form. Provide adequate information (operating system, steps leading to error, etc.) so we can help you efficiently.

License

This work is licensed under MIT. See LICENSE for more information.

How to cite

If you are using this package or reusing the source code from this repository for any purpose, please cite the corresponding Zenodo record. If you are using the latest version, you can see the citation instruction in the GitHub Citation panel or in the CITATION.cff file. You can also find the citation instruction on the Zenodo page https://doi.org/10.5281/zenodo.13376616 (especially if you would like to cite an older version).



logo

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

CodeMeta (codemeta.json) 

{
  "name": "Codefair",
  "@context": "https://w3id.org/codemeta/3.0",
  "applicationCategory": "Content management software",
  "author": [
    {
      "affiliation": {
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
        "type": "Organization"
      },
      "email": "dportillo@calmi2.org",
      "familyName": "Portillo",
      "id": "https://dorianportillo.dev",
      "givenName": "Dorian",
      "type": "Person"
    },
    {
      "affiliation": {
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
        "type": "Organization"
      },
      "email": "ssoundarajan@calmi2.org",
      "familyName": "Soundarajan",
      "id": "_:author_2",
      "givenName": "Sanjay",
      "type": "Person"
    },
    {
      "affiliation": {
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
        "type": "Organization"
      },
      "email": "bpatel@calmi2.org",
      "familyName": "Patel",
      "id": "_:author_3",
      "givenName": "Bhavesh",
      "type": "Person"
    }
  ],
  "codeRepository": "https://github.com/fairdataihub/codefair-app",
  "dateCreated": "2024-03-27",
  "dateModified": "2024-12-16",
  "datePublished": "2024-09-03",
  "description": "Codefair is a free and open source GitHub app that acts as your personal assistant when it comes to making your research software reusable and especially complying with the Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software (FAIR4RS Principles). Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, Codefair is here to assist you. ",
  "developmentStatus": "active",
  "downloadUrl": "https://github.com/marketplace/codefair-app",
  "identifier": "10.5281/zenodo.14503664",
  "issueTracker": "https://github.com/fairdataihub/codefair-app/issues",
  "keywords": [
    "best-practices",
    "fair",
    "research",
    "reusable",
    "software"
  ],
  "license": "https://spdx.org/licenses/MIT",
  "programmingLanguage": [
    "Vue",
    "JavaScript",
    "HTML",
    "TypeScript",
    "CSS",
    "Dockerfile"
  ],
  "relatedLink": [
    "https://docs.codefair.io/"
  ],
  "schema:releaseNotes": "## v3.2.1 - 12-12-2024\n\n### Added\n- Convert logging from 'consola' to 'logwatch' for improved log management and consistency across the application.\n\n### Fixed\n- Update CI and deployment workflows to include new environment variables 'BOT_LOGWATCH_URL' and 'VALIDATOR_URL'.\n- Patch to Zenodo workflow that was causing the user to be notified of a failed Zenodo upload when the upload was successful.\n- Fix issue with the metadata validation endpoint that was causing the service to return a 405 error.",
  "version": "3.2.1",
  "type": "SoftwareSourceCode"
}

GitHub Events

Total
  • Create event: 67
  • Commit comment event: 4
  • Issues event: 9
  • Release event: 4
  • Watch event: 5
  • Delete event: 48
  • Issue comment event: 303
  • Push event: 470
  • Pull request review comment event: 190
  • Pull request review event: 83
  • Pull request event: 118
Last Year
  • Create event: 67
  • Commit comment event: 4
  • Issues event: 9
  • Release event: 4
  • Watch event: 5
  • Delete event: 48
  • Issue comment event: 303
  • Push event: 470
  • Pull request review comment event: 190
  • Pull request review event: 83
  • Pull request event: 118

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 10
  • Total pull requests: 133
  • Average time to close issues: 27 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 8
  • Total pull request authors: 5
  • Average comments per issue: 1.3
  • Average comments per pull request: 3.69
  • Merged pull requests: 117
  • Bot issues: 7
  • Bot pull requests: 14
Past Year
  • Issues: 5
  • Pull requests: 81
  • Average time to close issues: 22 days
  • Average time to close pull requests: 1 day
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 2.2
  • Average comments per pull request: 3.79
  • Merged pull requests: 66
  • Bot issues: 3
  • Bot pull requests: 12
View more stats
Top Authors
Issue Authors
  • Aariq (4)
  • codefair-app[bot] (3)
  • hmenager (2)
  • slugb0t (2)
  • codefair-test[bot] (1)
  • doi-checker-app[bot] (1)
  • renovate[bot] (1)
  • license-check-bot[bot] (1)
  • codefair-staging[bot] (1)
Pull Request Authors
  • slugb0t (147)
  • megasanjay (73)
  • renovate[bot] (9)
  • codefair-io[bot] (3)
  • codefair-app[bot] (2)
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
type: dependencies (6) dependencies (2) javascript (2)

Dependencies

Dockerfile docker
  • node 20-slim build
package-lock.json npm
  • 602 dependencies
package.json npm
  • autoprefixer ^10.4.19 development
  • jest ^29.0.0 development
  • nock ^14.0.0-beta.5 development
  • postcss ^8.4.38 development
  • smee-client ^2.0.0 development
  • tailwindcss ^3.4.3 development
  • axios ^1.6.8
  • humanparser ^2.7.0
  • js-yaml ^4.1.0
  • probot ^12.2.4