Skip to content

New project

Raymond Schouten edited this page Nov 11, 2023 · 20 revisions

Creating repository

  1. Create GitHub repository
    • Repository name: [repository-name]
    • Description: [Description]

Initializing repository

  1. Clone repository via SSH
  2. Setup Git user configuration (if needed)
  3. Add default files from templates
  4. Push changes to main

Branch restrictions

  1. Configure branch restrictions for main (GitHub: Repository settings » Code and automation » Branches)
    • Branch name pattern: main
    • Protect matching branches:
      • Lock branch
  2. Configure branch restrictions for release branches (GitHub: Repository settings » Code and automation » Branches)
    • Branch name pattern: [0-9].[0-9]
    • Protect matching branches:
      • Require a pull request before merging
      • Do not allow bypassing the above settings

Documentation

  1. Configure Pages (GitHub: Repository settings » Code and automation » Pages)
    • Source: Deploy from branch
    • Branch: main /docs
  2. Add default files from templates
  3. Push changes to main

Project Board

  1. Create project board
  2. Make board publicly visible (GitHub: Project settings » Danger zone » Visibility)
  3. Configure columns:
    • Backlog: Issues in this lane are scheduled for any of the upcoming releases, but not yet ready to be picked up.
    • Ready: Issues in this lane are ready to be picked up.
    • In Progress: Issues in this lane are in progress.
    • In Test: Issues in this lane are being tested.
    • Closed: Issues in this lane are closed and will be released in any of the next releases.
  4. Configure workflows (GitHub: Project settings » Workflows):
    • Item added to project → Status: Backlog
    • Item reopened → Status: Backlog
    • Item closed → Status: Closed
    • Pull request merged → Status: Closed
  5. Add field Milestone (GitHub: Project view settings » Configuration » Fields):
  6. Set slice to Milestone (GitHub: Project view settings » Configuration » Slice by):