From cb3e65c544593dd78873bc2f4799b1a2b33f3f33 Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 11:04:29 +0100 Subject: [PATCH 1/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2cac3a5..16a5f06c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,10 +29,20 @@ This document provides guidelines for contributing to this repository. - Update the README or other documentation if necessary. - Clearly describe the changes you've made and their benefits. -## Contributing to the R Package +## Contributing to the R Package - author or reviewr of a PR -If your contribution involves changes to the R package itself, here are some specific guidelines to follow: +If your contribution involves changes to the R package itself (author or reviewer of a PR) here are some specific guidelines to follow: +1. Clone this GitHub repository and ensure all branches you need are up to date with remote. +2. Open up R Studio and ensure you have a **Git** tab in your workspace. +3. In this **Git** tab, move to the branch you want to make changes in (or review and test the changes of someone else). +4. Ensure that your current working directory is the R package directory you cloned (`getwd()` to check and `setwd()` to change). +5. Run `devtools::load_all()` in the R console. You should see `ℹ Loading browseMetadata` returned. +6. Test the function runs by running `domain_mapping()` in the R console. +7. Make your changes (or review changes made by others), and commit these changes in the way you choose to interact with git locally! + +If you run into issues with branches not seeming to be up to date in the R Studio workspace, consider running `remove.packages("browseMetadata")` and trying the above steps again, in case a previously installed package library is getting in the way somehow. + ### Working with Package Data - **Creating .rda Files**: To create `.rda` files in the data directory of the package, use the following command in R: From a0d4315002af67c42f36c7e92926525a8a189f42 Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 11:40:27 +0100 Subject: [PATCH 2/6] Update CONTRIBUTING.md Co-authored-by: Batool Almarzouq <53487593+BatoolMM@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 16a5f06c..407f4653 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ This document provides guidelines for contributing to this repository. ## Contributing to the R Package - author or reviewr of a PR -If your contribution involves changes to the R package itself (author or reviewer of a PR) here are some specific guidelines to follow: +If your contribution involves changes to the R package itself (as an author or reviewer of a PR), here are some specific guidelines, assuming you are using RStudio as your editor: 1. Clone this GitHub repository and ensure all branches you need are up to date with remote. 2. Open up R Studio and ensure you have a **Git** tab in your workspace. From 57221d2ed3ce0624168f1236bcef392d4d839de4 Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 11:40:52 +0100 Subject: [PATCH 3/6] Update CONTRIBUTING.md Co-authored-by: Batool Almarzouq <53487593+BatoolMM@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 407f4653..b989b147 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ This document provides guidelines for contributing to this repository. If your contribution involves changes to the R package itself (as an author or reviewer of a PR), here are some specific guidelines, assuming you are using RStudio as your editor: 1. Clone this GitHub repository and ensure all branches you need are up to date with remote. -2. Open up R Studio and ensure you have a **Git** tab in your workspace. +2. You should have a **Git** tab in your workspace. 3. In this **Git** tab, move to the branch you want to make changes in (or review and test the changes of someone else). 4. Ensure that your current working directory is the R package directory you cloned (`getwd()` to check and `setwd()` to change). 5. Run `devtools::load_all()` in the R console. You should see `ℹ Loading browseMetadata` returned. From 1fe0571278fcb19b41d8c3f01710afe44224614e Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:02:47 +0100 Subject: [PATCH 4/6] Update CONTRIBUTING.md Co-authored-by: Batool Almarzouq <53487593+BatoolMM@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b989b147..b9b1a925 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ This document provides guidelines for contributing to this repository. If your contribution involves changes to the R package itself (as an author or reviewer of a PR), here are some specific guidelines, assuming you are using RStudio as your editor: -1. Clone this GitHub repository and ensure all branches you need are up to date with remote. +1. Clone this GitHub repository and ensure all branches you need are up to date with remote. You can clone it by clicking on `File` > `New Project...`, then select `Version Control`, and choose `Git`. Enter the repository URL (e.g., `https://github.com/aim-rsf/browseMetadata`), select the directory to clone the repository into, and click `Create Project`. 2. You should have a **Git** tab in your workspace. 3. In this **Git** tab, move to the branch you want to make changes in (or review and test the changes of someone else). 4. Ensure that your current working directory is the R package directory you cloned (`getwd()` to check and `setwd()` to change). From 528a491e92adfb2bb821599a85768fd71278706b Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:04:28 +0100 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9b1a925..21abd5b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,8 @@ This document provides guidelines for contributing to this repository. If your contribution involves changes to the R package itself (as an author or reviewer of a PR), here are some specific guidelines, assuming you are using RStudio as your editor: -1. Clone this GitHub repository and ensure all branches you need are up to date with remote. You can clone it by clicking on `File` > `New Project...`, then select `Version Control`, and choose `Git`. Enter the repository URL (e.g., `https://github.com/aim-rsf/browseMetadata`), select the directory to clone the repository into, and click `Create Project`. +1. Clone this GitHub repository locally and ensure all branches you need are up to date with remote. +> In R Studio, you can clone it by clicking on `File` > `New Project...`, then select `Version Control`, and choose `Git`. Enter the repository URL (e.g., `https://github.com/aim-rsf/browseMetadata`), select the directory to clone the repository into, and click `Create Project`. 2. You should have a **Git** tab in your workspace. 3. In this **Git** tab, move to the branch you want to make changes in (or review and test the changes of someone else). 4. Ensure that your current working directory is the R package directory you cloned (`getwd()` to check and `setwd()` to change). From 11f1a7374e1656257a9f8f1deaaaf30c827b50dc Mon Sep 17 00:00:00 2001 From: Rachael Stickland <50215726+RayStick@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:05:58 +0100 Subject: [PATCH 6/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21abd5b4..9dc0700b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ This document provides guidelines for contributing to this repository. - Update the README or other documentation if necessary. - Clearly describe the changes you've made and their benefits. -## Contributing to the R Package - author or reviewr of a PR +## Contributing to the R Package - as an author or reviewer of a PR If your contribution involves changes to the R package itself (as an author or reviewer of a PR), here are some specific guidelines, assuming you are using RStudio as your editor: