# bcgov/bc-policy-framework-for-github architecture

> Architecture diagram of the GitHub repository bcgov/bc-policy-framework-for-github, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bcgov/bc-policy-framework-for-github
- Repository: https://github.com/bcgov/bc-policy-framework-for-github

## Overview

This repository is a policy and guidance library for BC Government employees and projects using GitHub, not a software runtime. Its main user journey is to start at the framework landing page and consult the Employee Guide, How To guides, or quick-reference cheatsheet. The documents cover organizational setup, contribution, security, licensing, and related policy topics. The README documents navigation to the main guide indexes and cheatsheet; no source excerpts were provided, so relationships among individual guide documents are not inferred.

Main entry points: [`README.md`](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/README.md) (Policy Framework), [`BC-Open-Source-Development-Employee-Guide/README.md`](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/README.md) (Employee Guide), [`BC-Gov-Org-HowTo/README.md`](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/README.md) (How-To Index), [`BC-Gov-Org-HowTo/Cheatsheet.md`](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Cheatsheet.md) (Cheatsheet)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_framework["Framework"]
  node_main["Policy Framework<br/>[README.md]"]
end

subgraph group_employee["Employee Guide"]
  node_employee["Employee Guide<br/>[README.md]"]
  node_principles["Principles<br/>[Principles.md]"]
  node_security["Security<br/>[Security.md]"]
  node_licenses["Licenses<br/>[Licenses.md]"]
  node_collaboration["Collaboration"]
  node_browsing["Browsing &amp; Use"]
  node_privacy["Privacy &amp; IP<br/>[COI-Priv-IP.md]"]
  node_approval["Content Approval"]
  node_appropriate["Appropriate Use<br/>[appropriate-use.md]"]
end

subgraph group_howto["Organization How-To"]
  node_howto["How-To Index<br/>[README.md]"]
  node_cheatsheet["Cheatsheet<br/>[Cheatsheet.md]"]
  node_joining["Join Organization"]
  node_creating["Create Repositories<br/>[Creating-Repos.md]"]
  node_forking["Fork Repositories<br/>[Forking-Repos.md]"]
  node_naming["Repository Naming<br/>[Naming-Repos.md]"]
  node_samples["Project Templates<br/>[SAMPLE-README.md]"]
end

node_employee_actor(("BC Government User"))

node_employee_actor -->|"consults"| node_main
node_main -->|"navigates to"| node_employee
node_main -->|"navigates to"| node_howto
node_main -->|"links to"| node_cheatsheet

click node_employee "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/README.md"
click node_principles "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Principles.md"
click node_security "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Security.md"
click node_licenses "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Licenses.md"
click node_collaboration "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Collaborating-Contributing.md"
click node_browsing "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/browsing-consuming.md"
click node_privacy "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/COI-Priv-IP.md"
click node_approval "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Content-Approval-Checklist.md"
click node_appropriate "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md"
click node_howto "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/README.md"
click node_cheatsheet "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Cheatsheet.md"
click node_joining "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Joining-the-BCGov-on-GitHub.md"
click node_creating "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Creating-Repos.md"
click node_forking "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Forking-Repos.md"
click node_naming "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Naming-Repos.md"
click node_samples "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/SAMPLE-README.md"
click node_main "https://github.com/bcgov/bc-policy-framework-for-github/blob/master/README.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_employee_actor toneBlue
class node_employee,node_principles,node_security,node_licenses,node_collaboration,node_browsing,node_privacy,node_approval,node_appropriate toneAmber
class node_howto,node_cheatsheet,node_joining,node_creating,node_forking,node_naming,node_samples toneMint
```

## Components

### Framework

- [Policy Framework](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/README.md): `README.md`

### Employee Guide

- [Employee Guide](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/README.md): `BC-Open-Source-Development-Employee-Guide/README.md`
- [Principles](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Principles.md): `BC-Open-Source-Development-Employee-Guide/Principles.md`
- [Security](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Security.md): `BC-Open-Source-Development-Employee-Guide/Security.md`
- [Licenses](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Licenses.md): `BC-Open-Source-Development-Employee-Guide/Licenses.md`
- [Collaboration](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Collaborating-Contributing.md): `BC-Open-Source-Development-Employee-Guide/Collaborating-Contributing.md`
- [Browsing & Use](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/browsing-consuming.md): `BC-Open-Source-Development-Employee-Guide/browsing-consuming.md`
- [Privacy & IP](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/COI-Priv-IP.md): `BC-Open-Source-Development-Employee-Guide/COI-Priv-IP.md`
- [Content Approval](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/Content-Approval-Checklist.md): `BC-Open-Source-Development-Employee-Guide/Content-Approval-Checklist.md`
- [Appropriate Use](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md): `BC-Open-Source-Development-Employee-Guide/appropriate-use.md`

### Organization How-To

- [How-To Index](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/README.md): `BC-Gov-Org-HowTo/README.md`
- [Cheatsheet](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Cheatsheet.md): `BC-Gov-Org-HowTo/Cheatsheet.md`
- [Join Organization](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Joining-the-BCGov-on-GitHub.md): `BC-Gov-Org-HowTo/Joining-the-BCGov-on-GitHub.md`
- [Create Repositories](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Creating-Repos.md): `BC-Gov-Org-HowTo/Creating-Repos.md`
- [Fork Repositories](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Forking-Repos.md): `BC-Gov-Org-HowTo/Forking-Repos.md`
- [Repository Naming](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/Naming-Repos.md): `BC-Gov-Org-HowTo/Naming-Repos.md`
- [Project Templates](https://github.com/bcgov/bc-policy-framework-for-github/blob/master/BC-Gov-Org-HowTo/SAMPLE-README.md): `BC-Gov-Org-HowTo/SAMPLE-README.md`

### Other components

- **BC Government User**

## Connections

- BC Government User → Policy Framework: consults (evidence: `README.md`)
- Policy Framework → Employee Guide: navigates to (evidence: `README.md`)
- Policy Framework → How-To Index: navigates to (evidence: `README.md`)
- Policy Framework → Cheatsheet: links to (evidence: `README.md`)
