Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

EPIC: Detect and Visualize Issue Bad Practice Detection #198

Open
19 tasks
iam-flo opened this issue Dec 2, 2024 · 0 comments
Open
19 tasks

EPIC: Detect and Visualize Issue Bad Practice Detection #198

iam-flo opened this issue Dec 2, 2024 · 0 comments
Assignees

Comments

@iam-flo
Copy link
Contributor

iam-flo commented Dec 2, 2024

Is your feature request related to a problem? Please describe.

Issues often exhibit bad practices that hinder effective task management and collaboration in software development. Common problems include missing or incomplete descriptions, lack of clear acceptance criteria, and vague or ambiguous titles. These bad practices can result in misunderstandings, misaligned priorities, and inefficiencies in resolving tasks. Novice developers, in particular, may struggle to create and interpret issues effectively, leading to project delays and frustration. There is currently no automated system to detect and flag such issues, making it difficult for teams to maintain consistency and clarity in issue tracking.

Describe the solution you'd like

An automated system to detect and visualize bad practices in issue creation and management. The system would analyze issue data and flag problems such as:

  • Missing or inadequate issue descriptions.
  • Vague or unclear issue titles.
  • Lack of defined acceptance criteria or labels.
  • Incomplete or missing links to related issues or pull requests.
    The system should also calculate and visualize issue metrics, such as the frequency of issues with missing descriptions, time to resolution, and trends in issue quality over time. These metrics should be displayed in a dashboard to help teams identify recurring issues and areas for improvement.

Tasks

  • Visualize issues in a dashboard.
  • Detect bad practices in issues:
    • Missing or incomplete descriptions.
    • Vague or ambiguous titles.
    • Lack of acceptance criteria.
    • Missing links to related tasks or documentation.
  • Calculate and visualize issue metrics in the dashboard:
    • Frequency of bad practices (e.g., missing descriptions).
    • Average time to resolution.
    • Trends in issue quality and practices over time.
  • Visualize issue bad practice trends (allow tracking trends even without current open issues):
    • Tendency to create issues without descriptions.
    • Tendency to create issues with unclear or ambiguous titles.
    • Trends in missing labels or acceptance criteria.
  • Add suggestions to improve issue creation practices:
    • Templates for clear and complete issue descriptions.
    • Examples of well-defined acceptance criteria.
    • Guidelines for linking issues to related tasks.
  • Integrate notifications
@iam-flo iam-flo self-assigned this Dec 2, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant