└── README.md /README.md: -------------------------------------------------------------------------------- 1 | # Kanban Template 2 | 3 | Visit `Projects` --> `Template` in this repository to see the Kanban/Project Tracker template. 4 | 5 | ## What is this for? 6 | 7 | One of the most important parts about being a team lead is having a method for tracking the issues the team will tackle during the semester. This achieves three goals: 8 | 1. Creating a concrete, actionable plan for achieving the semester's deliverables 9 | 2. Tracking progress towards those deliverables 10 | 3. Tracking member progress and success 11 | 12 | This tempate is a good starting point for creating an issue tracker for your team. 13 | 14 | ## What is a Kanban Board? 15 | 16 | The idea of a Kanban board is to create an easy mechanism for tracking each issue (or ticket, or story, whatever you want to call it...) the team will work on to complete a project. 17 | 18 | The board is organized as a sequence of columns. Each 'issue' your team will work on as a part of the project begins on the leftmost side, in the 'backlog' or 'todos'. As the issue progresses, it marches across the board, to 'In Development', 'In PR/Review', and finally, 'Done'. In that way, these boards make it easy to determine what's finished, what's left to do, and what's currently in progress for your team. 19 | 20 | ## How do I use this project template? 21 | 22 | To create your own board from this template: 23 | 1. Select `Projects` at the top of this repository 24 | 2. Select the `Template` project 25 | 3. Select `Menu` on the right-most side of the project screen 26 | 4. Select the three dots in the corner of the sidebar that appears 27 | 5. Select `Copy` 28 | 6. Choose the repo that you're in charge of from the list of Owners. 29 | 30 | It's a long list of steps, but at the end of it, you'll have a new project board in your repository! 31 | 32 | ## What does the template come with? 33 | 34 | This template comes with four columns: 35 | 1. Todo: the issues that remain for you to complete in the remainder of the semester. 36 | 2. In Progress: the issues that team members are actively working on. Could also be called `In Development`. 37 | 3. In Review: the issues that are in PR and are waiting for a review before they can be released. 38 | 4. Done: the issues that have been finished, merged into master, and (as applicable) released to production. 39 | 40 | There are other columns that might be useful for your team's workflow. For example, you might add an `In Design` column if your issues must come with a design specification by your team's designer, and the developer won't get started on it until that design is finished. This template isn't meant to be set in stone--it is most effective when it accurately describes the state of your project and reflects your team's development workflow. 41 | 42 | ## How should I use this new issue tracker? 43 | 44 | Your workflow with the issue tracker will look something like this: 45 | 1. At the beginning of the semester, once your goals are established, create a GitHub issue for each issue/ticket/'story' that the team will work on to get there 46 | 2. When a team member is available for new work, assign them one of the available tickets, and update the position of the ticket as the member makes progress 47 | 3. When all of the issues have moved from the `Backlog` to the `Done` column, you've reached your goals for the semester! 48 | 49 | If the board is accurate and up-to-date, this creates an effective visual representation to understand progress, both for members and for the team, and acts as a good source of truth for project and issue status. 50 | 51 | ## What can I do to make managing the board easier? 52 | 53 | At a lot of companies, a Kanban board is a physical entity--there's a big whiteboard covered in sticky notes, and members manually move these notes across the board as their issue progresses. Of course, you don't have the luxury of depending on something like that. But, GitHub gives you ways of mimicking this by automatically updating the status of tickets as members interact with the remote repository. 54 | 55 | GitHub allows you to do this by assigning an 'automation preset' to columns. These presets allow you to specify where a ticket should move as the GitHub Issue is updated or when a PR is created. For example, the `Todo` preset allows you to place all newly-created GitHub Issues automatically into your `Todo` column. To learn more about project board automation, see [Github's docs](https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-project-boards). 56 | --------------------------------------------------------------------------------