Issue and PR Hygiene

1. Overview

Issues, and PRs go through many changes throughout their lifespan - we need a set of guidelines to make sure they are filled out correctly, and maintained appropriately throughout their lifespan.

2. Scope

This document covers setting/maintaining project fields, labels, and PR<->Issue Linkages.

Intended Audience: Developers | Project Leads

3. Related Processes

• Issue Types
• Triage

4. Process/Main Body

Project Fields

GitHub Projects allow you to define custom fields for issues/PRs in the project. Not all fields must be filled out for an issue. the CCCL Project has the following fields:

• Status
  • To Do, In Progress etc.
• Type
  • Bug, Feature, Docs, Epic, Theme
• Priority
  • 0 > 1 > 2
• Roadmap
  • Which release?
• [CONDITIONAL] Start Date
  • Epic and Theme issues should have this filled out
  • Story/Task issues should not
• [CONDITIONAL] Target Date
  • Epic and Theme issues should have this filled out
  • Story/Task issues should not

As the issue moves through its lifecycle, project values must be kept up-to-date and filled out. If we only set these values during triage, then our project is a snapshot in time, and not a living reflection of our work.

Labels

CCCL is using a minimal label approach to make each label impactful.

Issues

With the move to the CCCL monorepo there are now labels for which library the issue falls under

• https://github.com/NVIDIA/cccl/labels/thrust
• https://github.com/NVIDIA/cccl/labels/libcu%2B%2B
• https://github.com/NVIDIA/cccl/labels/cub
• For issues that were originally NVBugs, use https://github.com/NVIDIA/cccl/labels/nvbug
• To promote OSS community interaction, use https://github.com/NVIDIA/cccl/labels/good%20first%20issue when applicable

PRs

There are two types of required PR labels for CI:

1. Type
   1. Bug
   2. Feature Request
   3. Improvement
   4. Documentation
2. Breaking Status
   1. Breaking
   2. Non-Breaking

• To make it clear when you need help visually within GitHub, use https://github.com/NVIDIA/cccl/labels/help%20wanted
• It is not required for PRs to have the library label

Issue <-> PR Linkage

All PRs must be linked to issues, aside from rare exceptions.

To link issues, you must either:

• Link them though the GH GUI in the issue under the "development" section in the issue or PR
• Use Closes keywords
  • While GitHub allows you to use things like Contributes to, this doesn't actually link them together. The only way offically link them is through closing keywords
  • This can create the scenario where an issue has 2 PRs linked and automation gets in the way
    • Issue 1 is linked to PR 2
    • Issue 1 is linked to PR 3
    • PR 2 is closed
    • Automation closes Issue 1
    • PR 3 is still open
  • In this case, we need to manually reopen Issue 1 and set to the correct status

5. References/Appendix

This section intentionally left blank.