Skip to content

Commit

Permalink
Update instructions for GitHub repository naming.
Browse files Browse the repository at this point in the history
  • Loading branch information
richardreeve committed Nov 28, 2022
1 parent 5d733ae commit ce8e6eb
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: RPiR
Type: Package
Title: Reproducible Programming in R
Version: 0.76.12
Version: 0.76.13
Authors@R: c(person("Sonia", "Mitchell", email = "[email protected]",
role = c("aut"),
comment = c(ORCID = "0000-0003-1536-2066")),
Expand Down
2 changes: 2 additions & 0 deletions inst/tutorials/practical2-1/practical2-1.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ documentation pages](https://sbohvm.github.io/RPiR/articles/pages/github.html)
that you used for the last practical, putting the repository in
the [SBOHVM](https://github.com/SBOHVM) organisation again, as before. Call this
project `githubusernameSeries02` (obviously use your real GitHub username!).
Remember that if your GitHub username has dashes or underscores, don't include
them in the repository name however, as they are illegal in R package names.
You'll use this single project for all of the exercises in this practical
series. If you are already in a coding group, then add the specific people that
need to be added to your repository on GitHub in **Settings** ->
Expand Down
4 changes: 3 additions & 1 deletion vignettes/pages/github.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ knitr::include_graphics('images/use-github-01.png')
You should always choose a short, descriptive name for your repository. But in
this case, to make it easier for us to identify you, please include your name
as well as an identifier associated with the practical you're working on, e.g.
`githubusernameSeries01`. Make sure you're creating
`githubusernameSeries01`. If your GitHub username has dashes or underscores,
don't include them in the repository name however, as they are illegal in R
package names. Make sure you're creating
a <span style="color: #de77ae;">Private</span> repository, check the box to
<span style="color: #de77ae;">Initialize this repository with a README</span>,
then select <span style="color: #de77ae;">Create repository</span>.
Expand Down

0 comments on commit ce8e6eb

Please sign in to comment.