Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 7.7 KB

File metadata and controls

152 lines (100 loc) · 7.7 KB
title intro allowTitleToDifferFromFilename miniTocMaxHeadingLevel versions type topics
Creating a project (beta)
Learn how to make a project, populate it, and add custom fields.
true
3
fpt ghec
*
*
tutorial
Projects

Projects are a customizable collection of items that stay up-to-date with {% data variables.product.company_short %} data. Your projects can track issues, pull requests, and ideas that you jot down. You can add custom fields and create views for specific purposes.

{% data reusables.projects.projects-beta %}

Creating a project

Creating an organization project

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

Creating a user project

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

Adding items to your project

Your project can track draft issues, issues, and pull requests.

Creating draft issues

Draft issues are useful to quickly capture ideas.

  1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}.
  2. Type your idea, then press Enter.

You can convert draft issues into issues. For more information, see Converting draft issues to issues.

Issues and pull requests

Paste the URL of an issue or pull request

  1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}.
  2. Paste the URL of the issue or pull request.

Searching for an issue or pull request

  1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}.
  2. Enter #.
  3. Select the repository where the pull request or issue is located. You can type part of the repository name to narrow down your options.
  4. Select the issue or pull request. You can type part of the title to narrow down your options.

Assigning a project from within an issue or pull request

  1. Navigate to the issue or pull request that you want to add to a project.

  2. In the side bar, click Projects.

  3. Select the project that you want to add the issue or pull request to.

  4. Optionally, populate the custom fields.

    Project sidebar

Converting draft issues to issues

In table layout:

  1. Click the {% octicon "triangle-down" aria-label="the item menu" %} on the draft issue that you want to convert.
  2. Select Convert to issue.
  3. Select the repository that you want to add the issue to.
  4. Alternatively, edit the assignee, labels, milestone, or repository fields of the draft issue that you want to convert.

In board layout:

  1. Click the {% octicon "kebab-horizontal" aria-label="the item menu" %} on the draft issue that you want to convert.
  2. Select Convert to issue.
  3. Select the repository that you want to add the issue to.

Removing items from your project

You can archive an item to keep the context about the item in the project but remove it from the project views. You can delete an item to remove it from the project entirely.

  1. Select the item(s) to archive or delete. To select multiple items, do one of the following:
    • Command+Click (Mac) or Ctrl+Click (Windows/Linux) each item.
    • Select an item then Shift+ or Shift+ to select additional items above or below the initially selected item.
    • Select an item then Shift+Click another item to select all items between the two items.
    • Enter Command+A (Mac) or Ctrl+A (Windows/Linux) to select all items in a column in a board layout or all items in a table layout.
  2. To archive all selected items, enter E. To delete all selected items, enter Del. Alternatively, select the {% octicon "triangle-down" aria-label="the item menu" %} (in table layout) or the {% octicon "kebab-horizontal" aria-label="the item menu" %} (in board layout), then select the desired action.

You can restore archived items but not deleted items. For more information, see Restoring archived items.

Restoring archived items

To restore an archived item, navigate to the issue or pull request. In the project side bar on the issue or pull request, click Restore for the project that you want to restore the item to. Draft issues cannot be restored.

Adding fields

As field values change, they are automatically synced so that your project and the items that it tracks are up-to-date.

Showing existing fields

Your project tracks up-to-date information about issues and pull requests, including any changes to the title, assignees, labels, milestones, and repository. When your project initializes, "title" and "assignees" are displayed; the other fields are hidden. You can change the visibility of these fields in your project.

  1. {% data reusables.projects.open-command-palette %}
  2. Start typing "show".
  3. Select the desired command (for example: "Show: Repository").

Alternatively, you can do this in the UI:

  1. Click {% octicon "plus" aria-label="the plus icon" %} in the rightmost field header. A drop-down menu with the project fields will appear. Show or hide fields
  2. Select the field(s) that you want to display or hide. A {% octicon "check" aria-label="check icon" %} indicates which fields are displayed.

Adding custom fields

You can add custom fields to your project. Custom fields will display on the side bar of issues and pull requests in the project.

Custom fields can be text, number, date, single select, or iteration:

  • Text: The value can be any text.
  • Number: The value must be a number.
  • Date: The value must be a date.
  • Single select: The value must be selected from a set of specified values.
  • Iteration: The value must be selected from a set of date ranges (iterations). Iterations in the past are automatically marked as "completed", and the iteration covering the current date range is marked as "current".
  1. {% data reusables.projects.open-command-palette %} Start typing any part of "Create new field". When "Create new field" displays in the command palette, select it.
  2. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} in the rightmost field header. A drop-down menu with the project fields will appear. Click New field.
  3. A popup will appear for you to enter information about the new field. New field
  4. In the text box, enter a name for the new field.
  5. Select the dropdown menu and click the desired type.
  6. If you specified Single select as the type, enter the options.
  7. If you specified Iteration as the type, enter the start date of the first iteration and the duration of the iteration. Three iterations are automatically created, and you can add additional iterations on the project's settings page.

You can later edit the drop down options for single select and iteration fields.

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

  1. Under Fields, select the field that you want to edit.
  2. For single select fields, you can add, delete, or reorder the options.
  3. For iteration fields, you can add or delete iterations, change iteration names, and change the start date and duration of the iteration.

Customizing your views

You can view your project as a table or board, group items by field, filter item, and more. For more information, see "Customizing your project (beta) views."

Configuring built-in automation

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

You can enable or disable the built-in workflows for your project.

{% data reusables.projects.enable-basic-workflow %}