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 Pull Request Bad Practices #196

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

EPIC: Detect and Visualize Pull Request Bad Practices #196

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.

Pull requests often exhibit bad practices that hinder collaboration and code quality in software development. Common issues include prolonged open pull requests, excessively large changes, missing or incomplete test coverage, and ambiguous or unclear pull request descriptions. These bad practices make it harder for teams to maintain efficiency, introduce technical debt, and create barriers for novice developers to learn and adapt to proper workflows. There is currently no automated mechanism to consistently identify and flag these issues, leaving them to be addressed through inconsistent and subjective manual oversight.

Describe the solution you'd like

An automated system to detect bad practices in pull requests. The system would analyze pull request data and flag issues such as:
Pull requests left open for too long without updates or progress.
Pull requests containing excessively large changes, making them difficult to review effectively.
Pull requests missing adequate test coverage or test updates.
Pull requests with ambiguous, incomplete, or unstructured descriptions.
The system should provide actionable feedback directly within GitHub to help developers identify and address these issues. This tool would promote better pull request practices, streamline workflows, and reduce technical debt.

Tasks

  • Visualize pull requests description bad practices in a dashboard #199
    • Scan and detect bad practices in pull requests on a schedule
      • Pull request description
    • Visualize pull request bad practices in dashboard combined with pull requests
  • Detect more bad practices
    • Pull request status
    • Pull request time
    • Pull request changes
  • Detect bad practices in realtime(faster than schedule)
  • Calculate and visualize pull request metrics in dashboard
  • Detect pull request metrics bad practice trends(allow to show trend for bad practices without concrete open PR)
    • Tendency to leave pull requests open too long
    • Tendency to have too short descriptions
  • Visualize trends in dashboard
  • Add suggestions how to fix or improve bad practices/habits
@iam-flo iam-flo self-assigned this Dec 2, 2024
@iam-flo iam-flo changed the title EPIC: Create bad practice detection for pull requests EPIC: Detect and Visualize Pull Request Bad Practices 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