Skip to content

Setup Instructions

Step 1: Create GitHub Repository

You have two options:

Option A: Using GitHub CLI (if authenticated)

gh repo create policy-repository --private --description "Acme Corp Platform - Policies and Procedures"

Option B: Using GitHub Web Interface

  1. Go to https://github.com/new
  2. Repository name: policy-repository
  3. Description: Acme Corp Platform - Policies and Procedures
  4. Visibility: Private
  5. Do NOT initialize with README, .gitignore, or license (we already have these)
  6. Click "Create repository"

Step 2: Push Code to GitHub

After creating the repository on GitHub, run:

cd c:/Users/bertc/policy-repository

# Add remote (replace YOUR-USERNAME with your GitHub username)
git remote add origin git@github.com:YOUR-USERNAME/policy-repository.git

# Push to GitHub
git push -u origin master

Step 3: Configure Repository Settings

Enable Branch Protection

  1. Go to repository Settings ? Branches
  2. Add branch protection rule for master:
  3. ? Require a pull request before merging
  4. ? Require approvals: 2
  5. ? Require review from Code Owners
  6. ? Require status checks to pass before merging
  7. ? Do not allow bypassing the above settings

Create GitHub teams for different policy reviewers: - security-team - compliance-team - hr-director - clinical-director - operations-lead

Then update the CODEOWNERS file with actual team/usernames.

Step 4: Update CODEOWNERS

Edit CODEOWNERS file and replace: - @your-username with your actual GitHub username - Team names with your organization's GitHub teams

# Example:
# Before:
* @your-username

# After:
* @bertcarlton @Acme Corp-compliance-team

Commit the change: 

git add CODEOWNERS
git commit -m "Update CODEOWNERS with actual usernames"
git push

Step 5: Test the Workflow

Test Policy Review Reminder

Run the workflow manually to test: 1. Go to Actions tab in GitHub 2. Click "Policy Review Reminder" 3. Click "Run workflow" 4. Check if it completes successfully

Test Pull Request Process

  1. Create a test branch: 

    git checkout -b test/new-policy

  2. Create a simple policy: 

    cp templates/policy-template.md policies/operations/test-policy.md
# Edit the file with basic info

  3. Commit and push: 

    git add policies/operations/test-policy.md
git commit -m "Add test policy"
git push -u origin test/new-policy

  4. Create Pull Request on GitHub

  5. Verify CODEOWNERS are requested as reviewers
  6. Verify PR template appears

Step 6: Configure Notifications (Optional)

Set up Slack/email notifications for: - New policy review issues - Pull request approvals needed - Workflow failures

Use GitHub webhooks or integrations.

Next Steps

  1. Migrate existing policies - Convert current Word/PDF policies to markdown
  2. Set review dates - Audit all policies and set appropriate next_review dates
  3. Train team - Show stakeholders how to review and update policies
  4. Schedule first review - Run the automated workflow weekly
  5. Create remaining policies - Use the template to document all organizational policies

Support

If you encounter issues: - Check GitHub Actions logs for workflow errors - Verify CODEOWNERS syntax: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners - Review branch protection rules if PRs are not enforcing reviews

Created: 2025-11-08