GitHub Projects Workflow Workshop
Learn how to use GitHub Projects for effective project management and collaboration.
Last updated
Learn how to use GitHub Projects for effective project management and collaboration.
Last updated
This workshop will guide you through the process of setting up and using GitHub Projects for effective project management and collaboration. You'll learn how to create a project, add tasks, link them to issues, and use different views to track progress.
Despite its name, GitHub Projects is not tied to a single repository. It's a project management tool that can be used across multiple repositories or even without any repository at all.
GitHub Projects is a flexible tool for planning and tracking work.
It can be used for various purposes, from software development to event planning.
Projects are not automatically tied to repositories when created.
Go to your GitHub profile or organization.
Click on "Projects" in the top navigation bar.
Click "New project".
Choose a template or start from scratch.
Give your project a name and description.
Like repositories, GitHub Projects can be public or private, and you need to manage access to them.
Go to your newly created project.
Click on the three dots (...) menu in the top right corner.
Select "Settings".
Go to "Manage access".
Add collaborators as needed.
GitHub Projects offers different views to help you visualize your work:
Board view: A Kanban-style board for task management.
Table view: A spreadsheet-like view for detailed tracking.
Roadmap view: A Gantt chart for timeline visualization.
Let's explore each of these:
In your project, click on the dropdown next to the current view name (likely "Board").
Select each view and observe how the information is presented differently.
In the Board view:
Click the "+ Add item" button at the bottom of a column.
Type a title for your task.
Press Enter to create the task.
Converting a task to an issue allows for better traceability and automation.
Click on a task to open its details.
Click on the "Convert to issue" button.
Select the repository where you want to create the issue.
Click "Create issue".
Click on the three dots (...) menu next to the task.
Select "Convert to issue" from the dropdown menu.
Click on a task to open its details.
In the sidebar, click on "Assignees".
Select the team member you want to assign the task to.
The Roadmap view helps in setting deadlines and visualizing the project timeline.
Switch to the Roadmap view.
Click and drag on a task to set its start and end dates.
Observe how tasks are arranged on the timeline.
Go to your repository on GitHub.
Click on the "Projects" tab.
Click "Link a project".
Select your project from the list.
Repeat these steps for each repository you want to link to the project. This allows you to:
Track issues and pull requests from multiple repositories in one place
Create cross-repository dependencies
Get a holistic view of your entire project, even when the code is distributed across different repositories
Remember, you can link as many repositories as needed to a single project, making it easier to manage large, multi-component software projects.
GitHub Projects allows you to manage automation workflows based on repository activity.
In your project, go to "Settings" > "Workflows".
You'll see a list of predefined workflows that you can enable or disable.
To adjust a workflow, click on it to edit its settings. For example, make sure the workflow "When an issue is closed, set its status to Done" is enabled. (Note: This workflow may already be enabled by default in some project templates).
