跳到主要内容

Issue Introduction

On the GitCode platform, an Issue is a tool used to track and manage project tasks, issues, feature requests, or discussions. Whether it's a bug discovered by developers in the code or a new feature suggestion from users, these can all be recorded and tracked through Issues.

提示

You can disable Issues in the project settings. Refer to Project Settings.

Accessing Issues​

Navigate to the project homepage and click on "Issues" in the tab bar to access the project's list of Issues.

image-20241231133558931

Main Uses​

  1. Bug Reports: When users or developers find issues in the project, they can use Issues to describe the problem in detail, including reproduction steps, expected behavior, and actual behavior, helping developers quickly locate and fix problems.
  2. Feature Requests: Users can propose new features or improvement suggestions for the project via Issues. Developers can evaluate and decide whether to implement them based on the requirements.
  3. Task Management: Issues can serve as a task list, helping teams allocate and track various tasks in the project, ensuring each task has a clear responsible person and progress.
  4. Discussions and Feedback: Issues can also be used for discussions related to the project. Team members can post opinions, provide feedback, and drive problem resolution or decision-making.

Basic Structure​

  • Title: Concisely summarize the core content of the issue or task.
  • Description: Provide detailed information about the background of the problem, reproduction steps, expected results, and actual results, or specific descriptions of feature requests.
  • Labels: Categorize Issues using labels, such as bug, enhancement, question, etc., making it easier to filter and manage.
  • Milestones: Associate Issues with specific project milestones to help the team plan and manage project progress.
  • Assignee: Assign Issues to specific responsible persons to ensure tasks are followed up.
  • Comments: Team members can discuss under Issues, providing solutions or additional information.

Issues and Labels​

Labels are used to categorize and identify Issues:

  1. A single Issue can have multiple Labels.
  2. Labels are typically used to indicate:
    • Problem Type: such as bug, feature, documentation.
    • Priority: such as high, medium, low.
    • Status: such as in progress, ready for review.
    • Scope: such as frontend, backend, UI/UX.
  3. Labels help the team quickly filter and find specific types of Issues.

Issues and Milestones​

A Milestone is used to organize Issues into specific project phases or release versions:

  1. A single Issue can only belong to one Milestone.
  2. Milestones are typically used for:
    • Version Releases: such as v1.0, v2.0.
    • Project Phases: such as Alpha, Beta, Release.
    • Time Nodes: such as 2024Q1, Sprint 1.
  3. Milestones can be set with due dates.
  4. You can view the completion progress of Milestones (number of completed Issues).

Best Practices​

  • Clear Descriptions: Ensure that the description of the Issue is as detailed as possible, making it easy for others to understand and reproduce the problem.
  • Use Labels: Reasonably use labels to categorize Issues for easier filtering and management later.
  • Timely Updates: During the process of solving Issues, update the status or add comments in a timely manner to keep the information transparent.
  • Close Resolved Issues: When problems are resolved or tasks are completed, promptly close the Issues to avoid backlog.

By using Issues effectively, teams can collaborate more efficiently, ensuring that issues and tasks in the project are handled promptly and smoothly driving the progress of the project.