{"id":34737407,"url":"https://github.com/rostools/github-intro","last_synced_at":"2026-05-25T22:03:10.163Z","repository":{"id":268412964,"uuid":"904265541","full_name":"rostools/github-intro","owner":"rostools","description":"An introductory workshop on using GitHub","archived":false,"fork":false,"pushed_at":"2026-05-05T07:30:32.000Z","size":1584,"stargazers_count":0,"open_issues_count":17,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-05-05T09:28:44.085Z","etag":null,"topics":["introduction","learn-github","open-education","open-education-resources","open-educational-resource","teaching","teaching-materials","workshop"],"latest_commit_sha":null,"homepage":"https://github-intro.rostools.org","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rostools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":".zenodo.json","notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-16T15:00:07.000Z","updated_at":"2026-05-05T07:30:35.000Z","dependencies_parsed_at":"2024-12-16T16:29:29.866Z","dependency_job_id":"91833fed-4eb6-409b-96cf-5bc1015c7ccb","html_url":"https://github.com/rostools/github-intro","commit_stats":null,"previous_names":["rostools/tutorial-github-intro","rostools/github-intro"],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/rostools/github-intro","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rostools%2Fgithub-intro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rostools%2Fgithub-intro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rostools%2Fgithub-intro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rostools%2Fgithub-intro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rostools","download_url":"https://codeload.github.com/rostools/github-intro/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rostools%2Fgithub-intro/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33494784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-25T14:31:05.219Z","status":"ssl_error","status_checked_at":"2026-05-25T14:31:02.878Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["introduction","learn-github","open-education","open-education-resources","open-educational-resource","teaching","teaching-materials","workshop"],"created_at":"2025-12-25T03:43:32.884Z","updated_at":"2026-05-25T22:03:10.156Z","avatar_url":"https://github.com/rostools.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# An introductory workshop on using GitHub for managing and working with files\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17019292.svg)](https://doi.org/10.5281/zenodo.17019292)\n[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)\n[![GitHub\nLicense](https://img.shields.io/github/license/rostools/github-intro)](https://github.com/rostools/github-intro/blob/main/LICENSE.md)\n[![GitHub\nRelease](https://img.shields.io/github/v/release/rostools/github-intro.svg)](https://github.com/rostools/github-intro/releases/latest)\n[![Build\nwebsite](https://github.com/rostools/github-intro/actions/workflows/build-website.yml/badge.svg)](https://github.com/rostools/github-intro/actions/workflows/build-website.yml)\n[![pre-commit.ci\nstatus](https://results.pre-commit.ci/badge/github/rostools/github-intro/main.svg)](https://results.pre-commit.ci/latest/github/rostools/github-intro/main)\n[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![Project Status: Active – The project has reached a stable, usable\nstate and is being actively\ndeveloped.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n\n## Description\n\nGitHub is increasingly used as a platform for collaborating and sharing\nresearch projects, not only for code but for documents. This workshop\naims to introduce learner to the basics of using GitHub for managing\nfiles and tracking changes to those files (version control). The\nworkshop is designed for learner who have little to no experience with\nGit and GitHub.\n\nThis repository contains the lesson, lecture, and assignment material\nfor the workshop, including the website source files and other\nassociated workshop administration and development files. For more\ndetail on the workshop, check out the [welcome\npage](https://github-intro.rostools.org/).\n\n\u003e [!TIP]\n\u003e\n\u003e This workshop repository was generated from the\n\u003e [`template-workshop`](https://github.com/rostools/template-workshop)\n\u003e rostools template.\n\n## Instructional Design\n\nThe lectures and lessons in this workshop are designed to be presented\nprimarily with a participatory live-coding approach. This involves an\nteacher typing and running code in an editor or similar platform in\nfront of the class, while the class follows along using their own\ncomputers. Challenges are interspersed in the lesson material, allowing\nparticipants to collaboratively work on smaller coding problems for a\nfew minutes. All lesson materials are provided ahead of time on the\nworkshop website for participants to refer to during lectures.\n\n## Lesson content\n\nThe teaching material is found mainly in these locations:\n\n- `index.Rmd`: Contains the overview of the workshop.\n- `overview/`: Contains the files that give an overview to the course,\n  such as the syllabus and schedule.\n- `pre-workshop/`: Contains the files necessary for use before the\n  workshop, for instance the pre-workshop tasks.\n- `sessions/`: Contains the files used during the workshop (e.g.\n  code-along material).\n- `appendix/`: Contains the files used to support the workshop, such as\n  pre-workshop tasks, code of conduct, resources, and instructions for\n  teachers.\n- `slides/`: The lecture slides are rendered into HTML slides from\n  Markdown.\n\nThe website is generated from [Quarto](https://quarto.org/), so it\nfollows the file and folder structure conventions from that package.\n\n## Support and infrastructure files\n\n- `.copier-answers.yml`: Contains the answers you gave when copying the\n  project from the template. **You should not modify this file\n  directly.**\n- `.cz.toml`:\n  [Commitizen](https://commitizen-tools.github.io/commitizen/)\n  configuration file for managing versions and changelogs.\n- `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/)\n  configuration file for managing and running checks before each commit.\n- `.typos.toml`: [typos](https://github.com/crate-ci/typos) spell\n  checker configuration file.\n- `.zenodo.json`: Structured citation metadata for your project when\n  archived on [Zenodo](https://zenodo.org/). This is used to add the\n  metadata to Zenodo when a GitHub release has been uploaded to Zenodo.\n- `justfile`: [`just`](https://just.systems/man/en/) configuration file\n  for scripting project tasks.\n- `.editorconfig`: Editor configuration file for\n  [EditorConfig](https://editorconfig.org/) to maintain consistent\n  coding styles across different editors and IDEs.\n- `CHANGELOG.md`: Changelog file for tracking changes in the project.\n- `CONTRIBUTING.md`: Guidelines for contributing to the project.\n- `.github/`: Contains GitHub-specific files, such as issue and pull\n  request templates, workflows,\n  [dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)\n  configuration, pull request templates, and a\n  [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)\n  file.\n\n## Contributing\n\nIf you are interested in contributing to the workshop material, please\nrefer to the [contributing guidelines](CONTRIBUTING.md). For guidelines\non how to be a helper or teacher, check out the [For\nteachers](https://r-cubed.rostools.org/for-teachers.html) page.\n\nPlease note that the project is released with a [Contributor Code of\nConduct](CODE_OF_CONDUCT.md). By contributing to or being involved in\nthis project, you agree to abide by its terms.\n\n### Contributors\n\nThese are the people who have contributed by submitting changes through\npull requests :tada:\n\n[@lwjohnst86](https://github.com/lwjohnst86),\n[@signekb](https://github.com/signekb),\n[@K-Beicher](https://github.com/K-Beicher),\n[@martonvago](https://github.com/martonvago)\n\n## Licensing\n\nThis project is licensed under the [CC-BY-4.0 License](LICENSE.md).\n\n## Re-use\n\nThe workshop is largely designed to be taught in the order given, as\neach session builds off of the previous ones. The easiest way to use\nthis material is to use it as-is, making use of the tips and\ninstructions found throughout this page. The only thing you might want\nto make as your own would be the slides, however, they are also good\nenough to use on their own too.\n\nTo help with general admin tasks of running the workshop, there is the\n[samwise](https://github.com/rostools/samwise) R package.\n\n## Changelog\n\nFor a list of changes, see our [changelog](CHANGELOG.md) page.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frostools%2Fgithub-intro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frostools%2Fgithub-intro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frostools%2Fgithub-intro/lists"}