Issues
Overview
Overview of the best practices for creating and updating issues for RAPIDS projects.
Intended audience
Community
Developers
See also
Create an issue
Important: Before creating an issue, please search existing open & closed issues and pull requests to see if your issue has already been addressed.
Follow the steps here to start the process of creating an issue.
Issues in RAPIDS projects fall into four types. When creating the issue, select the best fit from these options:
| Issue type | Title Prefix | Description |
|---|---|---|
| Bug | [BUG] |
Report a problem with the code |
| Documentation | [DOC] |
Report a problem or suggestion related to documentation |
| Feature | [FEA] |
Suggest an new idea or enhancement |
| Question | [QST] |
Ask the RAPIDS team a question about the project |
If you have an issue which truly is not one of the above, you can select Open a regular issue. Use this sparingly.
Consider adding good first issue or help wanted labels to the issue if applicable.
Format
Title
Use the appropriate type prefix outlined above. This should be automatically populated when creating the issue.
The title should be succinct description of problem, feature, or question. If code related, try to include the class or function name in the title.
Description
When using one of the four issue types, the description will be populated with a template which will guide how to describe the issue.
In general, you want to fully describe the issue so that someone can fully understand and reproduce the issue.
Task list
Every Bug, Documentation, and Feature issue should have a task list, even if it is a single item.
If you are unsure of the task breakdown, include a comment stating help is needed to determine the tasks.
As a developer works on an issue, perhaps after creating a [WIP] pull request, they should update the task list and mark tasks completed.
Blockers
If an issue is blocked due to another issue or pull request do the following:
- Add the 0 - Blocked label
- Add a task for each blocking issue to the top of the task list that says:
Waiting on issue ###
Lifecycle
Issues are either assigned by team leads or picked in priority order. If you are unsure what to work on, follow this guide.
When you begin work on an issue, update the labels to remove 1 - On Deck or 0 - Backlog and add 2 - In Progress.
When the associated pull request is merged, the issue will automatically close.