From f2d50bb43b0782b34185b9c4cd12266be06c9d55 Mon Sep 17 00:00:00 2001 From: jackhannah95 Date: Wed, 15 Apr 2020 17:24:14 +0100 Subject: [PATCH] fix links --- README.Rmd | 4 ++-- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.Rmd b/README.Rmd index 33f659c..c220f11 100644 --- a/README.Rmd +++ b/README.Rmd @@ -166,7 +166,7 @@ At present, the maintainers of this package are [David Caldwell](https://github. This package is intended to be in continuous development and contributions may be made by anyone within PHS. If you would like to make a contribution, please first create an [issue](https://github.com/Health-SocialCare-Scotland/phsmethods/issues) on GitHub and assign **both** of the package maintainers to it. This is to ensure that no duplication of effort occurs in the case of multiple people having the same idea. The package maintainers will discuss the issue and get back to you as soon as possible. -While the most obvious and eyecatching (as well as intimidating) way of contributing is by writing a function, this isn't the only way to make a useful contribution. Fixing typos in documentation, for example, isn't the most glamorous way to contribute, but is of great help to the package maintainers. Please see this [blogpost](https://www.tidyverse.org/blog/2017/08/contributing/) by Jim Hester for more information on getting started with contributing to open source software. +While the most obvious and eyecatching (as well as intimidating) way of contributing is by writing a function, this isn't the only way to make a useful contribution. Fixing typos in documentation, for example, isn't the most glamorous way to contribute, but is of great help to the package maintainers. Please see this [blogpost by Jim Hester](https://www.tidyverse.org/blog/2017/08/contributing/) for more information on getting started with contributing to open source software. When contributing, please create a [branch](https://github.com/Health-SocialCare-Scotland/phsmethods/branches) in this repository and carry out all work on it. Please ensure you have linked RStudio to your GitHub account using `usethis::edit_git_config()` prior to making your contribution. When you are ready for a review, please create a [pull request](https://github.com/Health-SocialCare-Scotland/phsmethods/pulls) and assign **both** of the package maintainers as reviewers. One or both of them will conduct a review, provide feedback and, if necessary, request changes prior to merging your branch. @@ -184,6 +184,6 @@ Please feel free to add yourself to the 'Authors' section of the `Description` f - All functions should be tested using [`testthat`](https://github.com/r-lib/testthat) - The package should always pass `devtools::check()` -It's not necessary to have experience with GitHub or of building an R package to contribute to `phsmethods`. If you wish to contribute code then, as long as you can write an R function, the package maintainers can assist with error handling, writing documentation, testing and other aspects of package development. It is advised, however, to consult Hadley Wickham's [R Packages](https://r-pkgs.org/) book prior to making a contribution. It may also be useful to consult the [documentation](https://github.com/Health-SocialCare-Scotland/phsmethods/tree/master/R) and [tests](https://github.com/Health-SocialCare-Scotland/phsmethods/tree/master/tests/testthat) of existing functions within this package as a point of reference. +It's not necessary to have experience with GitHub or of building an R package to contribute to `phsmethods`. If you wish to contribute code then, as long as you can write an R function, the package maintainers can assist with error handling, writing documentation, testing and other aspects of package development. It is advised, however, to consult [Hadley Wickham's R Packages book](https://r-pkgs.org/) prior to making a contribution. It may also be useful to consult the [documentation](https://github.com/Health-SocialCare-Scotland/phsmethods/tree/master/R) and [tests](https://github.com/Health-SocialCare-Scotland/phsmethods/tree/master/tests/testthat) of existing functions within this package as a point of reference. Please note that this README may fail to 'Knit' at times as a result of network security settings. This will likely be due to the badges for the package's release version, continuous integration status and test coverage at the top of the document. If you are editing the `README.Rmd` document and are unable to successfully get it to 'Knit', please contact the package maintainers for assistance. diff --git a/README.md b/README.md index 588d8cc..50331db 100644 --- a/README.md +++ b/README.md @@ -239,10 +239,10 @@ While the most obvious and eyecatching (as well as intimidating) way of contributing is by writing a function, this isn’t the only way to make a useful contribution. Fixing typos in documentation, for example, isn’t the most glamorous way to contribute, but is of great help to the -package maintainers. Please see this -[blogpost](https://www.tidyverse.org/blog/2017/08/contributing/) by Jim -Hester for more information on getting started with contributing to open -source software. +package maintainers. Please see this [blogpost by Jim +Hester](https://www.tidyverse.org/blog/2017/08/contributing/) for more +information on getting started with contributing to open source +software. When contributing, please create a [branch](https://github.com/Health-SocialCare-Scotland/phsmethods/branches) @@ -297,7 +297,7 @@ package to contribute to `phsmethods`. If you wish to contribute code then, as long as you can write an R function, the package maintainers can assist with error handling, writing documentation, testing and other aspects of package development. It is advised, however, to consult -Hadley Wickham’s [R Packages](https://r-pkgs.org/) book prior to making +[Hadley Wickham’s R Packages book](https://r-pkgs.org/) prior to making a contribution. It may also be useful to consult the [documentation](https://github.com/Health-SocialCare-Scotland/phsmethods/tree/master/R) and