friendly-github-intro

A Friendly Introduction to Github for Project Version Control

https://github.com/uf-repro/friendly-github-intro

Keywords

Repository

A Friendly Introduction to Github for Project Version Control

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

```{r, include = FALSE}

lesson_title <- "A Friendly Introduction to Github for Project Version Control"
lesson_description <- "Github is a cloud-based platform commonly used to host open-source coding project... this workshop will introduce how it can be used more broadly to back-up your research projects, collaborate within your lab and with remote colleagues, and even practice open science by (optionally) sharing your research project publicly."
lesson_version <- "1.1.1"
lesson_keywords <- c("Open Educational Resources",
                     "Research Support Skills",
                     "Git",
                     "GitHub",
                     "Version Control",
                     "Workshop")

folder_name <- basename(usethis::proj_get())
package_name <- gsub("-", ".", folder_name)
github_url <- sub("^git@github\\.com:", "https://github.com/", 
                  sub("\\.git$", "", usethis::git_remotes()$origin)
)

desc::desc_set(Package = package_name, 
               Title = lesson_title, 
               Description = lesson_description, 
               Version = lesson_version, 
               URL = github_url, 
               Version = lesson_version, 
               "X-schema.org-keywords" = paste(lesson_keywords, collapse = ", "))

cite_data <- list(
    title = lesson_title, 
    version = lesson_version, 
    creators = list(list(affiliation = "University of Florida", 
                 name = "Hao Ye", 
                 orcid = "0000-0002-8630-1458")), 
    description = lesson_description, 
    keywords = as.list(lesson_keywords), 
    license = cffr:::parse_desc_license(desc::desc()), 
    upload_type = "lesson"
)

jsonlite::write_json(cite_data, ".zenodo.json", 
                     auto_unbox = TRUE, pretty = TRUE)
```

# `r lesson_title`


[![GitHub Actions pkgdown workflow](https://github.com/uf-repro/friendly-github-intro/workflows/pkgdown/badge.svg)](https://github.com/uf-repro/friendly-github-intro/actions?query=workflow%3Apkgdown)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3937743.svg)](https://doi.org/10.5281/zenodo.3937743)



## Description

`r lesson_description`

*This workshop is open to everyone; NO previous experience with programming/git/command-line is required.*

## Learning Outcomes

```{r, include = FALSE}
learning_outcomes <- c("explain the benefits of version control",
                       "articulate the differences between `git` and `Github`",
                       "create and update repositories using Github Desktop and the Github website",
                       "write descriptive README files", 
                       "select and apply a license to a GitHub project")
outcomes_text <- paste0("* ", learning_outcomes, collapse = "\n")
desc::desc_set("learningOutcomes", outcomes_text)
```

By the end of the workshop, participants will be able to:

`r outcomes_text`

## References

* ["Friendly Github Workshop"](https://kirstiejane.github.io/friendly-github-intro/) from Kirstie Whitaker

Owner

GitHub Events