version-control-book

Source code for the Version Control Book, a guide to Git for scientists

https://github.com/lnnrtwttkhn/version-control-book

Science Score: 67.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 4 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 (12.5%) to scientific vocabulary

Keywords

git github open-educational-resources open-science teaching version-control
Last synced: 4 months ago · JSON representation ·

Repository

Source code for the Version Control Book, a guide to Git for scientists

Basic Info
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 6
  • Open Issues: 109
  • Releases: 1
Topics
git github open-educational-resources open-science teaching version-control
Created over 2 years ago · Last pushed 9 months ago
Metadata Files
Readme Funding License Citation Zenodo

README.md

The Version Control Book

DOI DOI Quarto Publish All Contributors Codespell

Description

Welcome to the Version Control Book, a resource initially created in the context of a course on version control at Universität Hamburg in 2023/2024.

The Version Control Book aims to summarize all the relevant course contents for the students, effectively serving as a textbook for this course. The book also aims to serve as an open-source learning resource for everyone, with a particular emphasis on providing guidance for researchers learning version control using Git and GitHub. This is a living resource on why and - more importantly - how to use Git. The rendered version is at https://lennartwittkuhn.com/version-control-book/ and is under constant development.

Contributing

Contributions in any form - pull requests, issues, content requests, ideas, etc. - are always welcome. If you are using the book and find that something does not work, please let us know. You can find out more on how to contribute here, and a list of all contributors so far below. Before contributing, please read the guidelines for contributions on how to get involved. To maintain consistency and readability, we follow a style guide. Please refer to the Style Guide for details on formatting, coding standards, and other conventions. We appreciate your contributions and look forward to building a comprehensive and valuable resource on version control!

Usage

To render and preview, execute:

bash quarto preview

License

CC-BY-SA

You are free to

  • share - copy and redistribute the material in any medium or format
  • adapt - remix, transform, and build upon the material for any purpose, even commercially

under the following terms:

1) Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

2) ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

Contributors

Lennart Wittkuhn
Lennart Wittkuhn

🐛 💻 🖋 🎨 📖 💡 💵 🔍 🤔 🚇 🚧 🧑‍🏫 📆 💬 👀 📢
Konrad Pagenstedt
Konrad Pagenstedt

🐛 💻 🖋 🎨 📖 💡 🤔 🚧 👀
Yaroslav Halchenko
Yaroslav Halchenko

🐛 💻 🚇 👀
paul-gallenkemper
paul-gallenkemper

💻
Ana Martinovici
Ana Martinovici

🤔
Justus Johannes Reihs
Justus Johannes Reihs

🐛 🤔
Aaron Peikert
Aaron Peikert

💬
lieku
lieku

💻 🖋 🐛 🚇 🚧 🤔
Rachad ADEKAMBI
Rachad ADEKAMBI

💻
LeonieDudda
LeonieDudda

💻
Juli Nagel
Juli Nagel

🐛

Owner

  • Name: Lennart Wittkuhn
  • Login: lnnrtwttkhn
  • Kind: user
  • Location: Berlin, Germany
  • Company: Max Planck Institute for Human Development

Postdoctoral Researcher investigating neural replay of task representations in the brain 🧠 👨‍🔬 Excited about coding, data management and reproducibility 🧮

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: Version Control Book
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Lennart
    family-names: Wittkuhn
    email: lennart.wittkuhn@tutanota.com
    affiliation: University of Hamburg
    orcid: 'https://orcid.org/0000-0003-2966-6888'
  - given-names: Konrad
    family-names: Pagenstedt
    email: konrad@pagenstedt.de
    affiliation: University of Hamburg
repository-code: 'https://github.com/lnnrtwttkhn/version-control-book'
url: 'https://lennartwittkuhn.com/version-control-book/'
abstract: >-
  The Version Control Book is a comprehensive educational
  resource for version control of code and data with Git for
  scientists.
keywords:
  - version control
  - git
  - github
  - reproducibility
  - open science
  - open eduational resources
license: CC-BY-SA-4.0

GitHub Events

Total
  • Issues event: 47
  • Watch event: 5
  • Delete event: 33
  • Issue comment event: 60
  • Member event: 2
  • Push event: 121
  • Pull request review event: 2
  • Pull request event: 73
  • Fork event: 2
  • Create event: 31
Last Year
  • Issues event: 47
  • Watch event: 5
  • Delete event: 33
  • Issue comment event: 60
  • Member event: 2
  • Push event: 121
  • Pull request review event: 2
  • Pull request event: 73
  • Fork event: 2
  • Create event: 31

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 19
  • Total pull requests: 18
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.89
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 18
  • Pull requests: 16
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 8 days
  • Issue authors: 6
  • Pull request authors: 4
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.81
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
  • lnnrtwttkhn (98)
  • konradpa (18)
  • lieku (11)
  • justus-reihs (8)
  • LeonieDudda (2)
  • yarikoptic (2)
  • paul-gallenkemper (1)
  • barbaraoberbauer (1)
  • einGlasRotwein (1)
  • allcontributors[bot] (1)
  • rezahakimazar (1)
Pull Request Authors
  • konradpa (45)
  • lnnrtwttkhn (41)
  • lieku (15)
  • allcontributors[bot] (7)
  • Rachad-Alabi-ADEKAMBI (1)
  • LeonieDudda (1)
  • paul-gallenkemper (1)
Top Labels
Issue Labels
enhancement (68) bug (9) content (8) documentation (5) icebox (5) good first issue (1) Ressources (1)
Pull Request Labels
enhancement (17) bug (3)

Dependencies

.github/workflows/codespell.yml actions
  • actions/checkout v3 composite
  • codespell-project/actions-codespell v2 composite
.github/workflows/publish.yml actions
  • actions/checkout v2 composite
  • quarto-dev/quarto-actions/publish v2 composite
  • quarto-dev/quarto-actions/setup v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-renv v2 composite