Skip to content

Files

Latest commit

 Cannot retrieve latest commit at this time.

History

History
157 lines (98 loc) · 7.14 KB

File metadata and controls

157 lines (98 loc) · 7.14 KB
title intro allowTitleToDifferFromFilename versions redirect_from type topics
Quickstart for {% data variables.product.prodname_projects_v2 %}
Experience the speed, flexibility, and customization of {% data variables.product.prodname_projects_v2 %} by creating a project in this interactive guide.
true
fpt ghec ghes
*
*
*
/issues/trying-out-the-new-projects-experience/quickstart
quick_start
Projects

Introduction

This guide demonstrates how to use {% data variables.product.prodname_projects_v2 %} to plan and track work. In this guide, you will create a new project and add a custom field to track priorities for your tasks. You'll learn how to create saved views that help you communicate priorities and progress with your collaborators. You'll also set up built-in workflows to manage the items in your project.

Prerequisites

You can either create an organization project or a user project. To create an organization project, you need a {% data variables.product.prodname_dotcom %} organization. For more information about creating an organization, see AUTOTITLE.

In this guide, you will add existing issues from repositories owned by your organization (for organization projects) or by you (for user projects) to your new project. For more information about creating issues, see AUTOTITLE.

Creating a project

First, create an organization project or a user project.

Creating an organization project

{% data reusables.projects.create-project %}

Creating a user project

{% data reusables.projects.create-user-project %}

Setting your project description and README

{% data reusables.projects.project-description %}

Adding issues to your project

Next, add a few issues to your project.

{% data reusables.projects.add-item-via-paste %}

Repeat the above steps a few times to add multiple issues to your project.

For more information and other ways to add issues to your project, or about other items you can add to your project, see AUTOTITLE.

Adding draft issues to your project

Next, add a draft issue to your project.

{% data reusables.projects.add-draft-issue %}

Adding an iteration field

Next, create an iteration field so you can plan and track your work over repeating blocks of time. Iterations can be configured to suit how you and your team works, with customizable lengths and the ability to insert breaks.

{% data reusables.projects.new-field %}

  1. Select Iteration
  2. To change the duration of each iteration, type a new number, then select the dropdown and click either days or weeks.
  3. Click Save.

Creating a field to track priority

Now, create a custom field named Priority and containing the values: High, Medium, or Low.

{% data reusables.projects.new-field %}

  1. Select Single select
  2. Below "Options", type the first option, "High".
  3. To add additional fields, for "Medium" and "Low", click Add option.
  4. Click Save.

Specify a priority for all issues in your project.

Screenshot showing a list of issues, each with a priority of "Low," "Medium," or "High" in the "Priority" field.

Grouping issues by priority

Next, group all of the items in your project by priority to make it easier to focus on the high priority items.

{% data reusables.projects.open-view-menu %}

  1. Click {% octicon "rows" aria-hidden="true" %} Group.
  2. Click Priority.

Now, move issues between groups to change their priority.

  1. Choose an issue.
  2. Drag and drop the issue into a different priority group. When you do this, the priority of the issue will change to be the priority of its new group.

Saving the priority view

When you grouped your issues by priority in the previous step, your project displayed an indicator to show that the view was modified. Save these changes so that your collaborators will also see the tasks grouped by priority.

{% data reusables.projects.save-view %}

You can share the URL with your team to keep everyone aligned on the project priorities.

When a view is saved, anyone who opens the project will see the saved view. Here, you grouped by priority, but you can also add other modifiers such as sort, filter, or layout. Next, you will create a new view with the layout modified.

Adding a board layout

To view the progress of your project's issues, you can switch to board layout.

The board layout is based on the status field, so specify a status for each issue in your project.

Then, create a new view.

{% data reusables.projects.new-view %}

Next, switch to board layout.

{% data reusables.projects.open-view-menu %}

  1. Under "Layout", click Board.

When you changed the layout, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future.

{% data reusables.projects.save-view %}

To indicate the purpose of the view, give it a descriptive name.

{% data reusables.projects.open-view-menu %}

  1. Click {% octicon "pencil" aria-hidden="true" %} Rename view.
  2. Type the new name for your view.
  3. To save changes, press Return.

Configure built-in automation

Next, configure the auto-add workflow to automatically add issues opened in a repository with a specific label to your project.

{% data reusables.projects.access-workflows %}

  1. In the "Default workflows" list, click Auto-add to project.

  2. To start editing the workflow, in the top right, click Edit.

    Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.

  3. Under "Filters", select the repository you want to add items from.

  4. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. For example, to catch all issues and PRs opened with the label "bug", use is:issue,pr label:bug.

  5. To enable the new workflow, click Save and turn on workflow.

Finally, add a built in workflow to set the status to Todo when an item is added to your project.

  1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu. Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.
  2. In the menu, click {% octicon "workflow" aria-hidden="true" %} Workflows.
  3. Under Default workflows, click Item added to project.
  4. Next to When, ensure that both issues and pull requests are selected.
  5. Next to Set, select Status:Todo.
  6. Click the Disabled toggle to enable the workflow.

Further reading