From the course: GitHub Issues and Projects for Teams
Creating a project - GitHub Tutorial
From the course: GitHub Issues and Projects for Teams
Creating a project
- [Instructor] As the number of issues in a standard repository grows, we will find that tracking the life cycle and progress of them increasingly difficult over time. By using GitHub projects, we gain a customizable tracking solution, using an easy-to-understand spreadsheet style for issues that teams thrive using, while eliminating the stale aspect of many existing tracking solutions. To begin, we'll head to our profile page to create our new project. Here under the Projects tab, we can then select the New project button. Once we select a new project, we'll be prompted to select a template for our project. As shown, the options range from start from scratch, or using a project template. Under the Start from scratch, we have the Table option, which will display our issues in a spreadsheet style. Under Board, it will show and display your issues in a Kanban style. We also have templates for a project, which is Team Backlog as well as Feature. I'm going to go ahead and select the Table option and then click on the Create button. Here we've created our new project, but we want to set a project description and README. We can set a project's description and README to share the purpose of the project, provide instructions on how to use the project, and include any relevant links. We can do so by clicking our menu option in the top right hand corner and selecting Settings. Here, we can now edit our project name, description, and README. I'm going to go ahead and edit our project name, (keyboard keys clacking) and add a short description, (keyboard keys clacking) and adding some information in our README. We can also go ahead and preview changes by clicking on the Preview button. And once we're happy with our changes, clicking on the Save button. Awesome, we can now go back to our project page. GitHub Projects track up to date information about issues including any changes to the title, assignees, labels, milestones, repository, reviewers, and linked pull requests. Initially, projects will, by default, display the title in assignees field, while the other fields are hidden, as shown here. Within our project page, we can change the visibility of these fields in our project. To showcase different fields, we can toggle them via the GitHub UI or via keyboard commands, which can be very helpful in quick navigation. Depending on which method we would like to use, let's go ahead and open the command palette. We can press Command + K for Mac users or Ctrl + K for Windows and Linux users to do so. Here, we can then go ahead and type in show followed by repository. And if we select it, it will run the command. And as you can see, it is now a selected field. If we go ahead and hide that, alternatively, through the UI, we can click the plus symbol in the right most field header and a dropdown menu will appear. Here, we can select the fields that we want to display or hide. A check mark symbol indicates which fields are currently displayed. We can also add custom fields to our project view. Custom fields will display on the sidebar of the issues in the project. Custom fields can be text, number, date, single select, or iteration. We can create the custom field, either through the keyboard command or the UI, as previously mentioned. To do so through a keyboard command, let's open the project command palette, once again using the Command + K for Mac users or Ctrl + K for Windows and Linux users, and then we can go ahead and start typing, Create new field, And if we select the Create new field it'll run the command. As you can see, it now prompt us for the field type and to enter a name. Alternatively, we can do it through the GitHub UI by clicking the plus symbol and then selecting the new field option. And, depending on what information we want to show, we can go ahead and edit accordingly. For example, if we specified iteration as a field type, we can also see that it's asking us for a start date for the first iteration and the duration of the iteration. Three iterations are automatically created and we can add additional iterations in the project setting page. For now, I'm just going to click on Save and Create and, as you can see, it shows in our header. If there is any additional information we would like to edit, such as the order of the options, changing names or values, we can head to the settings tab to do so. Now that we've created our first project, we can begin to envision how we can build it out to best suit our team. The first step in creating a customizable collection of items that stays up to date with issues and other data within GitHub repositories via project has been completed.