Project boards on GitHub are Kanban boards made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. Project boards help you organize and prioritize your work. This is what a project board looks like:
For more information, see "About project boards."
Project boards are typically used by teams to coordinate work on a specific project. I've also had great success using a project board for my personal to-do list, including tasks from multiple projects. Read on to learn how to use project boards in both ways.
You can create project boards to coordinate with your team on specific feature work, comprehensive roadmaps, or even release checklists.
First, decide if you need a repository project board or an organization-wide project board. Is the work you're coordinating limited to a single repository, such as building a specific feature? Or, do you want to include issues and pull requests from multiple repositories in your organization to create a comprehensive roadmap, for example?
Now, you can create your project board. If your project has a similar workflow to a past project, you might want to copy an existing project board. For more information, see "Copying a project board." Otherwise, you can start from scratch. You'll be able to build the project board entirely by yourself or choose from our templates. See "Creating a project board" for instructions.
Once you've created your project board, consider enabling automation. Automation eliminates some of the manual tasks in managing a project board by automatically performing actions when certain triggering events occur. For example, after you enable automation, when you close an issue that's in your project board, that issue will automatically move to the Done column. For more information, see "About automation for project boards."
Automation only moves cards between columns in your project board. To automate adding issues and pull requests to your project board in the first place, use query parameters. Add the
?projects= parameter to the URL for opening a new issue, like this:
If you want to report a bug, please [open an issue](https://github.com/lecoursen/test/issues/new?projects=lecoursen/test/1).
You can put that URL in your
CONTRIBUTING files or your default issue template, so people who are about to open an issue will use the correct URL. For more information, see "About automation for issues and pull requests with query parameters" and "Manually creating a single issue template for your repository."
I found using project boards so helpful for managing tasks with my coworkers that I started using one for my personal to-do list as well. In addition to providing email support to GitHub users, I also maintain the internal documentation for my team and write articles like this for the Community Forum. To manage all the tasks I'm responsible for across these projects, I created a project board in a private repository owned by my personal GitHub account (
Repository project boards can only contain issues and pull requests from that specific repository, so I can't add issues or pull requests from the GitHub repositories I work in to my project board directly. Luckily, you can add notes to a project board, and when that note contains the URL for an issue or pull request, you'll see a preview in a summary card, no matter which repository the issue or pull request belongs to:
For more information, see "Adding notes to a project board."
Every time I take on a new task at work, I add a card to one of my three to-do columns, one for each type of work I do: Support, Docs, and Community. Usually these cards reference an issue I've been assigned to (like the one above) or a pull request I've been requested to review. Sometimes, the card contains only a note reminding me to do something like watch the recording of a meeting I missed. I'm usually alerted to these tasks by Octobox, which I use to manage my GitHub web notifications. I can also check https://github.com/pulls and https://github.com/issues (which list all the pull requests and issues you've created, been assigned to, been mentioned in, or been requested to review) to see if I've missed anything.
The last thing I do each Friday is plan for the next work week by moving cards from these to-do columns to one of my doing columns: This Week. My other doing column is called Waiting... It's for anything that is in progress but not currently actionable by me. Usually this means pull requests that I've requested my colleagues review! Once they submit their reviews, I move the card back to This Week to remind myself to address their feedback.
When I finish a task, I move it to this year's done column. Right now, that column is called 2019 Review Cycle. In January, it will be easy to write the self assessment portion of my performance evaluation with the help of this list of tasks I completed in the past year! After that, I'll create a new done column, 2020 Review Cycle. The best system for you will depend on your own situation.
Finally, I have an Icebox column for things I started but have put on hold indefinitely... just in case I ever want to pick them back up. (It's hidden all the way to the right. 😆)
If you have any questions about my to-do list project board, please leave a comment below. If you need help using project boards generally, contact the Support Team! We'll be happy to help.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.