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

Visualize pull requests description bad practices in a dashboard #199

Open
7 tasks
Tracked by #196
iam-flo opened this issue Dec 2, 2024 · 0 comments · May be fixed by #200
Open
7 tasks
Tracked by #196

Visualize pull requests description bad practices in a dashboard #199

iam-flo opened this issue Dec 2, 2024 · 0 comments · May be fixed by #200
Assignees

Comments

@iam-flo
Copy link
Contributor

iam-flo commented Dec 2, 2024

Description

Develop a feature to detect and visualize bad practices in pull request descriptions, specifically targeting challenges faced by novice software engineers. The system should scan PR descriptions on demand and identify common issues, including:

  • Empty sections
  • Unchecked boxes
  • Missing or insufficient descriptions.
  • Vague or ambiguous language.
  • Lack of context or purpose for the changes.
  • Failure to outline specific changes made.
  • Missing references to related issues or documentation.

The detected bad practices should be displayed in a dashboard alongside the associated pull requests, helping novice engineers recognize and improve their description-writing skills.
The detected should be done by a LLM using specific rules for each workspace.

@iam-flo iam-flo changed the title Visualize pull requests in a dashboard Visualize pull requests bad practices in a dashboard Dec 2, 2024
@iam-flo iam-flo changed the title Visualize pull requests bad practices in a dashboard Visualize pull requests description bad practices in a dashboard Dec 2, 2024
@iam-flo iam-flo self-assigned this Dec 2, 2024
@iam-flo iam-flo linked a pull request Dec 2, 2024 that will close this issue
17 tasks
iam-flo added a commit that referenced this issue Dec 30, 2024
iam-flo added a commit that referenced this issue Dec 30, 2024
iam-flo added a commit that referenced this issue Jan 2, 2025
iam-flo added a commit that referenced this issue Jan 2, 2025
iam-flo added a commit that referenced this issue Jan 2, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant