Data

Tools

Indexes

Applications

Experiments

Open Source Science

git-collaboration

Intermediate level course on using Git for collaboration

https://github.com/fair2-for-research-software/git-collaboration

Science Score: 75.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
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization fair2-for-research-software has institutional domain (rse.shef.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

collaboration commit foss git github opensource training-material vc versioncontrol
Last synced: 4 months ago · JSON representation ·

Repository

Intermediate level course on using Git for collaboration

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 23
  • Releases: 1
Topics
collaboration commit foss git github opensource training-material vc versioncontrol
Created about 2 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Git Collaboration

DOI

This lesson uses The Carpentries Workbench to develop training material for an intermediary level course on using Git effectively for collaboration.

Course Description

Git is a powerful tool for distributed, collaborative and version controlled "software" development. As with any powerful tool the amount of different options and ways of using it are many resulting in an often bewildering or overwhelming experience for those trying to learn how to use it.

This course seeks to develop material that focuses on some of the more advanced topics and tasks involved with using Git and many of the tasks that make the process of collaborating using Git easier to understand.

  • Consolidate concepts of branches and working with them.
  • Introduce some simple practices for Git hygeine that keep the repository, issues and pull requests tidy and easier to understand.
  • The power and uses of Git Hooks.
  • Leveraging Continuous Integration in work flows.
  • Effective Reviewing
  • Project Management tools

Contributions

Contributions are welcome please refer to the contribution guidelines of how to do so and ensure you adhere to the Code of Conduct.

Building Locally

To render these pages locally you need to have R installed. Instructions are available but some additional steps have been taken to make sure the environment is reproducible using the {renv} package and an renv.lockfile is included which allows the environment to be recreated along with dependencies, including the

After cloning the repository you can setup the renv and install all packages with

``` r renv::restore()

Optionally update packages

renv::update() ```

Once you have installed the dependencies you can render the pages locally by starting R in the project root and running...

r sandpaper::serve()

This will build the pages and start a local web-server in R and open it in your default browser. These pages are "live" and as you edit and save them the web-site will be rebuilt and the pages updated.

Owner

  • Name: UoS FAIR2 for research software
  • Login: FAIR2-for-research-software
  • Kind: organization
  • Email: rse@sheffield.ac.uk

Training in FAIR (Findable, Accessible, Interoperable, Reusable) and Reproducible research software skills at the University of Sheffield

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: Git Collaboration
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Neil
    family-names: Shephard
    email: n.shephard@sheffield.ac.uk
    affiliation: University of Sheffield
    orcid: 'https://orcid.org/0000-0001-8301-6857'
identifiers:
  - type: doi
    value: 10.5281/zenodo.15498182
    description: Git Collaboration
repository-code: 'https://github.com/ns-rse/git-collaboration'
url: 'https://ns-rse.github.io/git-collaboration/'
abstract: >-
  A Carpentry based, intermediate level course on using Git
  for effective collaboration.
keywords:
  - git
  - collaboration
  - carpentries
license: CC-BY-4.0

GitHub Events

Total
  • Issues event: 43
  • Delete event: 36
  • Issue comment event: 42
  • Push event: 125
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 47
  • Create event: 41
Last Year
  • Issues event: 43
  • Delete event: 36
  • Issue comment event: 42
  • Push event: 125
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 47
  • Create event: 41

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 27
  • Total pull requests: 47
  • Average time to close issues: 3 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 1.48
  • Average comments per pull request: 1.0
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 23
  • Pull requests: 47
  • Average time to close issues: 12 days
  • Average time to close pull requests: 1 day
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.65
  • Average comments per pull request: 1.0
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
  • ns-rse (13)
  • tdjames1 (8)
Pull Request Authors
  • ns-rse (36)
  • tdjames1 (6)
  • pre-commit-ci[bot] (4)
Top Labels
Issue Labels
feedback (9) course material (8) diverging branches (3) introduction (3) branching (2) session (1)
Pull Request Labels
feedback (7) type: template and tools (4) introduction (4) enhancement (3) setup (2)

Dependencies

.github/workflows/pr-close-signal.yaml actions
  • actions/upload-artifact v3 composite
.github/workflows/pr-comment.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
  • carpentries/actions/download-workflow-artifact main composite
.github/workflows/pr-post-remove-branch.yaml actions
  • carpentries/actions/download-workflow-artifact main composite
  • carpentries/actions/remove-branch main composite
.github/workflows/pr-preflight.yaml actions
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
.github/workflows/pr-receive.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/sandpaper-main.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-cache.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-lockfile main composite
  • carpentries/create-pull-request main composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-workflows.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-workflows main composite
  • carpentries/create-pull-request main composite