blueprints

Software development blueprints for epiverse-trace

https://github.com/epiverse-trace/blueprints

Science Score: 64.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 11 committers (18.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.1%) to scientific vocabulary

Keywords

best-practices epiverse internal-docs onboarding r-package-development standard-operating-procedure standards

Keywords from Contributors

stan climate
Last synced: 6 months ago · JSON representation ·

Repository

Software development blueprints for epiverse-trace

Basic Info
Statistics
  • Stars: 3
  • Watchers: 4
  • Forks: 4
  • Open Issues: 30
  • Releases: 3
Topics
best-practices epiverse internal-docs onboarding r-package-development standard-operating-procedure standards
Created over 3 years ago · Last pushed 11 months ago
Metadata Files
Readme Citation

README.md

CC BY 4.0 render-blueprints DOI

Welcome to this repository!

This repository stores the Epiverse-TRACE Blueprints for software development. You can:

Contributions

Tell us what you think

Questions and comments on the blueprints are welcome through github issues. If you would like to suggest edits to the blueprints but do not want to make a pull request (see below), feel free to suggest these edits directly as an issue.

Contributions via pull requests

Contributions are welcome via pull requests, usually after discussing edits in an issue. The blueprints file to edit is index.qmd. This quarto file is used to render the blueprints to html. This rendering is done automatically every time index.qmd changes on the main branch. When making pull requests, it is best to only commit changes to the qmd file.

In a nutshell, the workflow for contributions would look something like:

  1. Install quarto

  2. Clone the repository using SSH; this is only needed the first time your download the git repository.

  3. Run git pull to fetch the latest version of the repository.

  4. Create a new branch to make your changes typing git checkout -b [name_of_your_branch].

  5. Make changes to the relevant quarto (file with .qmd extension), and save the file.

  6. From your terminal, run quarto render. The html output will be generated in the _book/ folder.

  7. Repeat the two previous steps as many times as needed. Commit the final changes using:

git add index.md git commit -m "quick summary of changes" git push --set-upstream origin [name_of_your_branch]

  1. Open a pull request on github, using your branch, and explaining briefly which changes you have made.

Notes

Please note that this project uses a Contributor Code of Conduct. By contributing, you agree to abide by its terms.

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY).

Owner

  • Name: Epiverse-TRACE
  • Login: epiverse-trace
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Epiverse-TRACE blueprints
message: "If you use this book, please cite it using the metadata from this file."
type: software
authors:
  - given-names: James
    family-names: Azam
  - given-names: Anna
    family-names: Carnegie
  - given-names: Rosalind
    family-names: Eggo
  - given-names: Rich
    family-names: FitzJohn
  - given-names: Dawn
    family-names: Foster
  - given-names: Hannah
    family-names: Frick
  - given-names: Sebastian
    family-names: Funk
  - given-names: Cyril
    family-names: Geismar
  - given-names: Sarah
    family-names: Gibson
  - given-names: Miguel Enrique
    family-names: Gámez López
  - given-names: Geraldine
    family-names: Gómez Millán
  - given-names: Hugo
    family-names: Gruson
  - given-names: Ernest
    family-names: Guevarra
  - given-names: Pratik
    family-names: Gupte
  - given-names: Thibaut
    family-names: Jombart
  - given-names: Joshua
    family-names: Lambert
  - given-names: Emma
    family-names: Marty
  - given-names: Ibrahim
    family-names: Mahgoub
  - given-names: Karim
    family-names: Mané
  - given-names: Nuredin
    family-names: Mohammed
  - given-names: Andrés
    family-names: Moreno
  - given-names: Rebecca
    family-names: Nash
  - given-names: Julian David
    family-names: Otero Acosta
  - given-names: Jaime
    family-names: Pavlich-Mariscal
  - given-names: David Santiago
    family-names: Quevedo Vega
  - given-names: Maëlle
    family-names: Salmon
  - given-names: Malvika
    family-names: Sharan
  - given-names: Janetta
    family-names: Skarp
  - given-names: Tim
    family-names: Taylor
  - given-names: Nicolás
    family-names: Torres
  - given-names: Heather
    family-names: Turner
  - given-names: Juan Daniel
    family-names: Umaña
  - given-names: Andree
    family-names: Valle Campos
  - given-names: Chantal
    family-names: Wood
identifiers:
  - type: doi
    value: 10.5281/zenodo.7062318
repository-code: 'https://github.com/epiverse-trace/blueprints'
url: 'https://epiverse-trace.github.io/'
keywords:
  - standards
  - software development
license: CC-BY-4.0

GitHub Events

Total
  • Issues event: 27
  • Delete event: 10
  • Issue comment event: 34
  • Push event: 41
  • Pull request event: 21
  • Pull request review event: 38
  • Pull request review comment event: 31
  • Create event: 11
Last Year
  • Issues event: 27
  • Delete event: 10
  • Issue comment event: 34
  • Push event: 41
  • Pull request event: 21
  • Pull request review event: 38
  • Pull request review comment event: 31
  • Create event: 11

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 200
  • Total Committers: 11
  • Avg Commits per committer: 18.182
  • Development Distribution Score (DDS): 0.585
Past Year
  • Commits: 57
  • Committers: 9
  • Avg Commits per committer: 6.333
  • Development Distribution Score (DDS): 0.737
Top Committers
Name Email Commits
Hugo Gruson B****o 83
Thibaut Jombart t****t@g****m 36
Joshua Lambert j****t@l****k 23
James Azam j****m@g****m 15
Chris Hartgerink c****s@l****g 15
GitHub Action a****n@g****m 9
Jaime Pavlich-Mariscal j****h 7
Maëlle Salmon m****n@y****e 6
Karim MANE 8****e 4
Andree Valle Campos a****m@g****m 1
Abdoelnaser M Degoot d****t@a****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 50
  • Total pull requests: 63
  • Average time to close issues: 6 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 11
  • Total pull request authors: 9
  • Average comments per issue: 2.16
  • Average comments per pull request: 1.29
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 7
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 9 days
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 0.83
  • Average comments per pull request: 1.43
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Bisaloo (15)
  • joshwlambert (10)
  • jamesmbaazam (9)
  • GeraldineGomez (8)
  • chartgerink (6)
  • avallecam (5)
  • thibautjombart (5)
  • jpavlich (3)
  • maelle (2)
  • pratikunterwegs (2)
  • sbfnk (1)
  • avinashladdha (1)
  • Degoot-AM (1)
  • juan-umana (1)
Pull Request Authors
  • Bisaloo (52)
  • chartgerink (14)
  • joshwlambert (12)
  • maelle (6)
  • jpavlich (3)
  • Karim-Mane (2)
  • Degoot-AM (1)
  • avallecam (1)
  • thibautjombart (1)
  • TimTaylor (1)
  • jamesmbaazam (1)
Top Labels
Issue Labels
discussion (7) good first issue (5) documentation (4) resource-library (2) attribution (1) fix-link (1) code-review (1) help wanted (1) question (1) governance (1)
Pull Request Labels
documentation (2) code-review (1)

Dependencies

.github/workflows/render_blueprints.yml actions
  • actions/checkout v2 composite
  • actions/deploy-pages v1 composite
  • actions/upload-pages-artifact v1 composite
  • quarto-dev/quarto-actions/setup v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-renv v2 composite
  • r-lib/actions/setup-tinytex v2 composite