https://github.com/fair2-for-research-software/git-with-it
Intermediate level course on using Git for collaboration
https://github.com/fair2-for-research-software/git-with-it
collaboration commit foss git github opensource training-material vc versioncontrol
Last synced: about 13 hours ago
JSON representation
Intermediate level course on using Git for collaboration
- Host: GitHub
- URL: https://github.com/fair2-for-research-software/git-with-it
- Owner: FAIR2-for-research-software
- License: other
- Created: 2023-10-09T14:17:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-30T00:14:07.000Z (6 days ago)
- Last Synced: 2025-09-30T02:27:09.737Z (5 days ago)
- Topics: collaboration, commit, foss, git, github, opensource, training-material, vc, versioncontrol
- Homepage: https://fair2-for-research-software.github.io/git-with-it/
- Size: 5.69 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Git With It
[](https://doi.org/10.5281/zenodo.15498183)
This lesson uses [The Carpentries Workbench][workbench] to develop training material for an intermediary level course on
using Git effectively for collaboration.
## Course Description
[Git][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][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](CONTRIBUTING.md) of how to do so and ensure you
adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
### Building Locally
To render these pages locally you need to have [R][r] installed. Instructions are
[available](https://carpentries.github.io/workbench/#installation) but some additional steps have been taken to make
sure the environment is reproducible using the [`{renv}`](https://rstudio.github.io/renv/articles/renv.html) 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.
[git]: https://git-scm.com
[r]: https://www.r-project.org/
[workbench]: https://carpentries.github.io/workbench/