Gitbranch structure02

_pkgdown.yml

@@ -8,6 +8,7 @@ articles:
   contents:
   - project_structure
   - using_github
+  - github_branches
   - package_development
   - data_table
 

vignettes/data_table.Rmd

@@ -1,8 +1,8 @@
 ---
-title: "04 Improve efficiency with `data.table`"
+title: "05 Improve efficiency with `data.table`"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{04 Improve efficiency with `data.table`}
+  %\VignetteIndexEntry{05 Improve efficiency with `data.table`}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
@@ -161,8 +161,8 @@
   height = c(180, 165, 175, 160, 185, 170)
 )
 # dplyr
 max_height_df <- height %>%
   group_by(gender) %>%
   dplyr::summarise(max_height = max(height))
 
 # first transform data to data.table class
@@ -203,12 +203,12 @@
 # Creating second dataset
 df2 <- data.frame(
   customer_id = sample(1:(n_rows * 10), n_rows, replace = FALSE),
   customer_name = paste0("Customer_", sample(1:(n_rows * 10), n_rows, replace = FALSE))
 )
 
 # Joining with dplyr
 joined_df <- left_join(df1, df2, by = "customer_id") %>%
   select(customer_id, transaction_amount, customer_name) %>%
   arrange(customer_id)
 
 # Converting to data.table
@@ -216,9 +216,9 @@
 dt2 <- data.table::as.data.table(df2)
 
 # Joining with data.table
 joined_dt <- dt2[dt1, on = "customer_id"] %>%
   as.data.frame() %>%
   select(customer_id, transaction_amount, customer_name) %>%
   arrange(customer_id)
 
 identical(joined_df, joined_dt)
@@ -299,7 +299,7 @@
 )
 
 # Convert to wide format using dplyr
 wide_df <- long_df %>%
   pivot_wider(
     names_from = variable,
     values_from = value
@@ -330,7 +330,7 @@
 )
 
 # Convert to long format using dplyr
 long_df <- wide_df %>%
   pivot_longer(
     cols = starts_with("value"),
     names_to = "variable",

vignettes/github_branches.Rmd

@@ -0,0 +1,72 @@
+---
+title: "03 Github Branches"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{03 Github Branches}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+## Overview
+This article provides a description of the Git branching workflow used to maintain the `createslf` package in line with NSS BI BYOC infrastructure. It explains how branches are structured, how code moves from one environment to another, and what protection rules apply. It is intended for all PHS analysts contributing to this project and serves as a reference for day‑to‑day Git usage.
+
+## Acronyms Reference
+* BI – Business Intelligence (NSS)
+* BYOC – Bring Your Own Code
+* PR – Pull Request
+* SLF – Source Linkage Files
+* UAT – User Acceptance Testing
+
+## Branching Structure
+The project uses a three‑tier protected branching model:
+
+`master` → `main-byoc` → `UAT` → `development`
+
+### Branching Workflow:
+**master (production)** – Represents the code currently deployed in production
+
+* Must be protected: No direct pushes and PRs must be approved by 1 SLF team member + 1 NSS BI member.
+* Ensures: A stable, production environment and that all production code has been peer‑reviewed.
+
+**main-byoc (infrastructure integration)** – Acts as the integration layer between SLF R code and NSS BI BYOC-specific configurations
+
+* Holds the BYOC artefacts including the wrapper and utility scripts.
+* Owned primarily by NSS BI.
+
+**UAT (User Acceptance Testing)** – Used for end‑user testing after changes are validated in development
+
+* PRs must be reviewed by one PHS member and one NSS BI member.
+* Code here is deployed into the UAT environment.
+* When UAT is successful, code moves to main-byoc → then to master.
+
+**development** – Represents the current state of code under active development
+
+* PRs must be reviewed by one PHS member.
+* All feature branches must be created from this branch.
+
+**Feature branches (working branches)** – Created when working on issues
+
+* Always created from development
+* After testing locally, raise a PR → merge into development
+
+### Merge Visual Workflow:
+
+```{r, echo=FALSE, out.width="85%"}
+knitr::include_graphics("images/git_flow.png")
+```
+
+### Workflow Summary
+| Branch               | Purpose                  | Approval Required     |
+|----------------------|--------------------------|-----------------------|
+| `master`             | Production Code          | PHS + NSS BI          |
+| `main-byoc`          | BYOC Integration         | PHS + NSS BI          |
+| `UAT`                | User Testing             | PHS + NSS BI          |
+| `development`        | Integration of Features  | PHS                   |
+| `feature`            | Individual Work          | N/A (Local Testing)   |

vignettes/package_development.Rmd

@@ -1,8 +1,8 @@
 ---
-title: "03 Package Development"
+title: "04 Package Development"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{03 Package Development}
+  %\VignetteIndexEntry{04 Package Development}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---