Skip to main content

GitHub Project Guidelines

Purpose​

This document provides comprehensive guidelines for using GitHub Projects as our primary project management tool. It ensures consistent project tracking, efficient collaboration, and effective progress monitoring across all teams.

Scope​

Includes​

  • GitHub Projects setup and configuration
  • Issue management and workflows
  • Time tracking and estimation
  • Project board organization
  • Automation rules and processes
  • Template setup and maintenance
  • Label management

Excludes​

  • Code review processes
  • Deployment procedures
  • Development workflows
  • Repository management
  • Branch strategies

Project Setup​

1. Project Board Creation​

  1. Use standard project board template
  2. Configure columns and automation
  3. Set up custom fields
  4. Define labels and milestones
  5. Configure automation rules

2. Issue Management​

  1. Use issue templates
  2. Apply appropriate labels
  3. Set milestones
  4. Assign story points
  5. Link related issues

3. Workflow Configuration​

  1. Define column transitions
  2. Set up automation rules
  3. Configure notifications
  4. Set up integrations
  5. Define access permissions

Project Organization​

Board Structure​

  • Backlog: Upcoming work
  • To Do: Current sprint tasks
  • In Progress: Active work
  • Review: Pending review
  • Done: Completed work

Issue Labels​

  • Type: bug, feature, docs, etc.
  • Priority: high, medium, low
  • Status: blocked, needs review
  • Component: frontend, backend, etc.
  • Epic: project milestones

Custom Fields​

  • Story Points
  • Sprint
  • Due Date
  • Dependencies
  • Stakeholders

Best Practices​

Issue Creation​

  • Clear, descriptive titles
  • Detailed descriptions
  • Acceptance criteria
  • Technical requirements
  • Dependencies listed

Board Management​

  • Regular backlog grooming
  • Daily board updates
  • Sprint planning
  • Milestone tracking
  • Progress monitoring

Time Tracking​

  • Story point estimation
  • Time logging
  • Sprint velocity
  • Burndown charts
  • Capacity planning

Automation Rules​

Issue Movement​

  • Auto-move on PR creation
  • Auto-move on PR merge
  • Auto-assign reviewers
  • Auto-label based on content
  • Auto-close stale issues

Notifications​

  • PR review requests
  • Issue assignments
  • Milestone updates
  • Due date reminders
  • Sprint notifications

Tools and Integration​

Development Tools​

  • GitHub Actions
  • Branch protection
  • Code review tools
  • CI/CD integration

Project Management​

  • Time tracking
  • Reporting tools
  • Analytics
  • Documentation

References​

  • Issue Template
  • PR Template
  • Project Board Template
  • Milestone Template
  • Development Workflow