fair-code

A template to make your software more FAIR compliant

https://github.com/manugil/fair-code

Science Score: 36.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

A template to make your software more FAIR compliant

Basic Info
  • Host: GitHub
  • Owner: manuGil
  • Language: Jinja
  • Default Branch: main
  • Homepage:
  • Size: 316 KB
Statistics
  • Stars: 12
  • Watchers: 2
  • Forks: 8
  • Open Issues: 1
  • Releases: 4
Created about 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

Fair Code

TUDelft DCC License

A template to make your software more FAIR compliant with the TU Delft Software Guidelines

How to Use

This template requires Python 3.8+

New Project

If starting a new project from scratch, you can follow these steps: 1. Use pipx to install copier, and render the template.

```shell

intalling copier

pipx install copier ```

  1. Start a new software project using this template:

python copier copy https://github.com/manuGil/fair-code.git <path/to/project-directory>

  1. Finally, initize a Git repository in your project directory:

shell cd <path/to/project-directory> git init git add . git commit -m 'initial commit'

Existing Project

If you have an existing project and want to use this template, you can use the following command:

  1. Use pipx to install copier, and render the template.

```shell

intalling copier

pipx install copier ```

  1. Make sure your existing project is a Git repository. If not, you can initialize it with:

shell cd <path/to/existing-project-directory> git init git add . git commit -m 'initial commit'

  1. apply the template to your existing project: shell copier copy https://github.com/manuGil/fair-code.git <path/to/exiting-project-directory>

  2. Finally, commit the changes to your exising project:

shell git add . git commit -m 'apply template to existing project'

Contributing

Read our guidelines to know how to be part of the development of this template.

License

This template is freely available under an Apache License 2.0

Acknowledgements

Owner

  • Name: Manuel Garcia
  • Login: manuGil
  • Kind: user
  • Location: Enschede
  • Company: Delft University of Technology

researcher on information technology, software engineer, and a constant learner

GitHub Events

Total
  • Create event: 4
  • Release event: 2
  • Issues event: 3
  • Watch event: 3
  • Issue comment event: 2
  • Push event: 6
  • Pull request event: 4
  • Fork event: 3
Last Year
  • Create event: 4
  • Release event: 2
  • Issues event: 3
  • Watch event: 3
  • Issue comment event: 2
  • Push event: 6
  • Pull request event: 4
  • Fork event: 3

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 22
  • Total Committers: 2
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.091
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Manuel G. Garcia g****2@g****m 20
Meta Keijzer 7****t 2

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 4
  • Total pull requests: 6
  • Average time to close issues: over 3 years
  • Average time to close pull requests: 19 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.25
  • Average comments per pull request: 0.17
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • manuGil (4)
Pull Request Authors
  • manuGil (5)
  • Metahofzicht (2)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
enhancement (5)