Skip to main content

Project Management Workflow

To maintain organization and transparency across the Inky (Crab-Ink) project, we utilize GitHub Projects as our central source of truth for task management.

Tools & Resources

1. Planning & Task Definition

All project tasks are defined within the GitHub Project Board.

  • The board serves as the backlog and roadmap.
  • Tasks are created as items on the board first to capture the requirement or feature request.

2. Issue Conversion

Based on how work Github Project, when a task is created it create automatically a GitHub Issue.

  • The issue is linked to the specific repository where the code or work will reside.
  • This links the Project Board directly to the repositories.

3. Sprint Planning & Assignment

We operate in 1 to 2-week sprints.

  • Assignment: Tasks are assigned to team members primarily during our scheduled planning meetings.
  • Scope: The team decides which issues are moved from the "Backlog" to the "Sprint" column based on priority and capacity.

For Team Members

When working on a task:

  1. Check the Board: Always verify the status of your assigned issues on Project.
  2. Update Status: As you progress (e.g., from Todo to In Progress to Done), ensure the board reflects reality.
  3. Link PRs: When opening a Pull Request, link it to the corresponding Issue to automatically close the issue (and update the board) upon merging.

Reference: official GitHub Project documentation.