Skip to content

Project Usage

Ben Jarmak edited this page Apr 27, 2023 · 4 revisions

1. Overview

This document serves as the template for all other processes, while the content will be very different, each should maintain the same flow for team familiarity and ease of use. Very short intro/purpose statement.

2. Scope

This document covers how to use a project, written for multiple perspectives. It does not cover how to configure a project.

Intended audience: Developers | Project Leads | Community

3. Related Processes

4. Process/Main Body

I am an engineer and I want to…

Understand priority within the project

Priority is reflected in two ways:

  1. Within a release
    • Items are sorted in top-down priority in the roadmap view
    • This is a living priority and may change - we are not codifying a value as they tend to go stale quickly and if an item shifts release it needs to be reassessed regardless
  2. Outside of a release
    • The roadmap value of an item shows its estimated priority
    • Current release > next numbered releases > Priority Backlog > Backlog
    • We do not sort the items within a future release for priority, too much can change and it's low value compared to other efforts the team can be doing

Update project data directly from the issue

Issues and PRs that are in a project can edit every field in the project directly from the issue page:

  1. Navigate to your issue
  2. On the right hand column in ‘Projects’ click on the carat to expand the modifiable fields - every field in the project can be modified from here

See all work assigned to me in the current release

This can be done in a few different ways - in this approach I’ll use the Roadmap View to see issues assigned to a specific users by release.

  1. Navigate to your project
  2. Select the view titled My Work

I am a team lead and I want to...

Change the release of an issue

To change the release of an issue/PR, change the value of the Roadmap single-select project field to the release you want it to be in. You can change this value from either the project view, or when inside the issue/PR.

Add a new release, or rearrange releases

Since releases are a single-select field, values need to be added in the project settings page. In this page, we can also rearrange the display order of the fields.

To get to the settings page we can either click on the gear in the top-right corner of the projects page, and then click on the field you want to modify:

Or in a table-style view that the field is visible in, you can click on the ‘...’ next to the field name and go directly to its settings page:

In the settings page for that field, add new values and drag to reorder as necessary. Usually after a release, we move it to immediate after the ‘Product backlog’ and create the n+2 release:

Change the ‘Release Sheet/Board/PR’ view after a release

Instead of making new projects, the new project system just changes the filter in these views. To change from 22.12 to 23.02:

  1. Change the filter on the Roadmap field like below, then save the changes

  2. You’ll need to update the ‘Release/Roadmap’ field of any issues that did not get completed during the release, for information on this, please see the Roadmapping and Planning Process.

See all work assigned to my team

On any view, you can add assignee filters to show the issues of people on your team. Access the filter bar as described above and type in the usernames you want to see, separated by a comma. An Example could be: https://github.com/orgs/rapidsai/projects/41/views/5?filterQuery=is%3Aissue+-is%3Adraft+assignee%3AisVoid%2Cthomcom%2C%22jarmak-nv%22+

Create Themes or Epics

See Issue Types for information on creating Epics/Themes.

I am a stakeholder and I want to...

See all of the high-level work being done

High-level views of the work being done is conveyed through the theme/epics. Filtering to see high-level views is dependent on the approach the library uses to capture epics.

CCCL has an ‘Epics’ view setup already in the project to account for this - navigate to the project and select the Epic view.

Additionally, a filter based on the title containing "[THEME]" or "[EPIC]" could be added to any view.

Understand the release roadmap

To find what work is going into the release navigate to the ‘Roadmap’ or ‘Release’ view.

Find and understand specific issues

This can be done in two ways - either through https://github.com/NVIDIA/cccl/issues, or the project in the roadmap view.

  • Navigate to the preferred method
  • Add to the search/filter bar what you’re interested in

5. References/Appendix

Any final thoughts/references go here.