Bugfix
Everything about bug-type issues.
Bugfix issues are used to track and resolve bugs in the project. These issues help maintain the quality and reliability of the codebase by addressing problems that affect functionality.
Label
All bugfix issues are created with the bugfix-label. The default label for creating a bugfix-type issue is bugfix. You can configure this label as follows:
jobs:
git-board-issues:
name: Git Board - Issue
runs-on: ubuntu-latest
steps:
- uses: vypdev/copilot@v2
with:
bugfix-label: bugfix
Naming
The default tree for creating bugfix branches is bugfix. You can configure this tree name as follows:
jobs:
git-board-issues:
name: Git Board - Issue
runs-on: ubuntu-latest
steps:
- uses: vypdev/copilot@v2
with:
bugfix-tree: bugfix
Bugfix branches follow this naming convention:
bugfix/NUM-ISSUE-issue-name
For example:
bugfix/123-fix-login-validation
Source
Bugfix branches are created from the development branch. By default, bugfix branches are created from the develop branch. You can configure the development branch name as shown below:
jobs:
git-board-issues:
name: Git Board - Issue
runs-on: ubuntu-latest
steps:
- uses: vypdev/copilot@v2
with:
development-branch: develop
Images
You can configure custom images to be displayed in the comments of bugfix issues. These images will be randomly selected and displayed when Copilot performs actions on the issue.
To configure the images, provide a comma-separated list of image URLs in the images-issue-bugfix input:
jobs:
git-board-issues:
name: Git Board - Issue
runs-on: ubuntu-latest
steps:
- uses: vypdev/copilot@v2
with:
images-issue-bugfix: url1, url2, url3
Template
You can use this template for bugfix issues that helps capture all the necessary information. The template includes fields for:
- Checking for duplicate issues
- Selecting affected actions and platforms
- Providing a detailed bug description
- Including steps to reproduce
- Specifying copilot version
- Adding relevant log output
- Including additional context and comments
You can find this template in .github/ISSUE_TEMPLATE/bug_report.yml. Below is an example of how the template looks when creating a new bugfix issue:
name: 🐛 Bug Report
description: Report a bug on copilot
title: "<YOUR TITLE HERE>"
labels: ["bug", "bugfix"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: |
Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues.
required: true
- type: markdown
attributes:
value: |
---
- type: dropdown
id: plugins
attributes:
label: Which actions are affected?
multiple: true
options:
- Issue
- Pull Request
- Commits
- type: dropdown
id: platforms
attributes:
label: Which platforms are affected?
multiple: true
options:
- macOS
- Windows
- Linux
- type: markdown
attributes:
value: |
---
- type: textarea
attributes:
label: Description
description: |
Describe the issue. Explain what you _expected_ to happen and what
_actually_ happened.
validations:
required: true
- type: textarea
attributes:
label: Reproducing the issue
description: |
Please provide either **steps to reproduce** or a [**minimal reproducible example**](https://stackoverflow.com/help/minimal-reproducible-example).
Providing a minimal reproducible example will help us triage your issue
faster.
validations:
required: true
- type: markdown
attributes:
value: |
---
- type: input
attributes:
label: copilot Version
description: What version of copilot is being used?
placeholder: "master"
validations:
required: true
- type: markdown
attributes:
value: |
---
- type: textarea
attributes:
label: Relevant Log Output
description: |
Please copy and paste any relevant log output.
placeholder: |
Paste your logs here. Please redact any personally identifiable
information. This will be automatically formatted into code, so no
need for backticks.
render: shell
validations:
required: false
- type: textarea
id: comments
attributes:
label: Additional context and comments
description: |
Anything else you want to add for this issue?