GitScrum / Docs
All Best Practices

GitHub Integration | Sync PRs & Commits

Integrate GitHub with GitScrum for complete visibility. Sync PRs, commits, code reviews, and CI/CD status automatically to task timelines.

5 min read

GitHub is where code lives, but project management needs extend beyond repository features. GitScrum's GitHub integration bridges this gap by synchronizing issues, pull requests, and commits with your project boards, providing comprehensive visibility across development and management activities.

Integration Benefits

Standalone ToolsIntegrated Workflow
Manual sync between systemsAutomatic updates
Duplicate data entrySingle source of truth
Context switchingUnified view
Lost traceabilityComplete audit trail
Delayed visibilityReal-time status

Setting Up GitHub Integration

INTEGRATION SETUP STEPS

1. CONNECT GITHUB ACCOUNT
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  GitScrum β†’ Settings β†’ Integrations β†’ GitHub    β”‚
β”‚                                                 β”‚
β”‚  β€’ Authorize GitScrum app                       β”‚
β”‚  β€’ Select repositories                          β”‚
β”‚  β€’ Configure permissions                        β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

2. MAP REPOSITORIES TO PROJECTS
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  Project: Mobile App                            β”‚
β”‚  β”œβ”€β”€ frontend-mobile (GitHub repo)              β”‚
β”‚  └── api-backend (GitHub repo)                  β”‚
β”‚                                                 β”‚
β”‚  All activity from these repos β†’ this project   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

3. CONFIGURE AUTOMATION
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  PR Opened β†’ Task status: In Review             β”‚
β”‚  PR Merged β†’ Task status: Done                  β”‚
β”‚  CI Failed β†’ Add label: needs-fix               β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Workflow Integration

DEVELOPER WORKFLOW WITH INTEGRATION

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                   GITSCRUM                      β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”‚
β”‚  β”‚ Task: GS-123                             β”‚   β”‚
β”‚  β”‚ "Add user authentication"                β”‚   β”‚
β”‚  β”‚                                          β”‚   β”‚
β”‚  β”‚ Status: In Review                        β”‚   β”‚
β”‚  β”‚                                          β”‚   β”‚
β”‚  β”‚ Timeline:                                β”‚   β”‚
β”‚  β”‚ β”œβ”€β”€ 9:00 AM  Branch created              β”‚   β”‚
β”‚  β”‚ β”œβ”€β”€ 10:30 AM Commit: Add login API       β”‚   β”‚
β”‚  β”‚ β”œβ”€β”€ 11:15 AM Commit: Add tests           β”‚   β”‚
β”‚  β”‚ β”œβ”€β”€ 11:30 AM PR #42 opened              β”‚   β”‚
β”‚  β”‚ β”œβ”€β”€ 2:00 PM  Review requested            β”‚   β”‚
β”‚  β”‚ └── 3:30 PM  Changes requested           β”‚   β”‚
β”‚  β”‚                                          β”‚   β”‚
β”‚  β”‚ Linked PR: #42 (awaiting review)         β”‚   β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚
β”‚                      ↕                          β”‚
β”‚                  SYNCED                         β”‚
β”‚                      ↕                          β”‚
β”‚                   GITHUB                        β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”‚
β”‚  β”‚ PR #42: GS-123 Add user authentication   β”‚   β”‚
β”‚  β”‚                                          β”‚   β”‚
β”‚  β”‚ Description:                             β”‚   β”‚
β”‚  β”‚ Implements login flow per task GS-123    β”‚   β”‚
β”‚  β”‚ [Link to GitScrum task]                  β”‚   β”‚
β”‚  β”‚                                          β”‚   β”‚
β”‚  β”‚ Status: Review requested                 β”‚   β”‚
β”‚  β”‚ Checks: βœ“ CI passing                     β”‚   β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Commit Linking

COMMIT TO TASK LINKING

COMMIT MESSAGE FORMAT:
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  GS-123: Add user login endpoint                β”‚
β”‚                                                 β”‚
β”‚  - Implement POST /api/auth/login               β”‚
β”‚  - Add JWT token generation                     β”‚
β”‚  - Include rate limiting                        β”‚
β”‚                                                 β”‚
β”‚  Closes GS-123                                  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

RESULT IN GITSCRUM:
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  Task GS-123 Timeline:                          β”‚
β”‚                                                 β”‚
β”‚  [Commit] abc1234 by @developer                 β”‚
β”‚  "Add user login endpoint"                      β”‚
β”‚  +145 lines, -12 lines                          β”‚
β”‚  3 files changed                                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

PR Review Workflow

PR STATUS FLOW

GitHub PR State        β†’    GitScrum Task State
───────────────────────────────────────────────
Draft                  β†’    In Progress
Ready for Review       β†’    In Review
Changes Requested      β†’    In Review (flagged)
Approved               β†’    Ready to Merge
Merged                 β†’    Done
Closed (not merged)    β†’    To Do (returned)

REVIEW VISIBILITY:
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  Task: GS-123                                   β”‚
β”‚                                                 β”‚
β”‚  PR Status: Changes Requested                   β”‚
β”‚  Reviewer: @seniordev                           β”‚
β”‚  Comment: "Need error handling for edge case"   β”‚
β”‚                                                 β”‚
β”‚  CI Status: βœ“ Passing                           β”‚
β”‚  Code Coverage: 87%                             β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Best Practices

  • Use task IDs consistently in branches and PRs
  • Configure status automation to reduce manual updates
  • Link repositories to projects for proper context
  • Enable PR templates that include task links
  • Review task context before code review
  • Sync only necessary events to avoid noise
  • Use GitHub Actions with GitScrum webhooks
  • Archive completed work with full Git history
  • Anti-Patterns

    βœ— Using both GitHub Issues and GitScrum separately
    βœ— Manual status updates when automation exists
    βœ— PRs without task references
    βœ— No repository-to-project mapping
    βœ— Ignoring CI status in task view
    βœ— Too many notification syncs (noise)
    

    Related Solutions