Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

create activity endpoint returning pull requests with bad practices(#… #200

Draft
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

iam-flo
Copy link
Contributor

@iam-flo iam-flo commented Dec 2, 2024

#199

Motivation

This PR aims to address the challenge of improving the quality of pull request descriptions, particularly for novice software engineers. By developing a system that detects and visualizes bad practices in PR descriptions, we aim to provide actionable insights that enhance understanding and foster better documentation habits.

Description

This PR implements two key components of the system:
Activity Dashboard: A visual interface to display detected bad practices alongside the associated pull requests. This helps users quickly identify areas for improvement.
Bad Practice Rule Page: A configurable interface to define and manage workspace-specific rules for detecting common issues in PR descriptions.
These features form the foundation for the larger system that leverages an LLM for bad practice detection, creating a dynamic and scalable solution.

Testing Instructions

Start both server and client.
Navigate to http://localhost:4200/activities/iam-flo and test activity dashboard
Navigate to http://localhost:4200/workspace and to rules page and test it

Screenshots (if applicable)

Include screenshots here showcasing the Activity Dashboard and Rule Page interfaces if available.

General

  • PR title is clear and descriptive
  • PR description explains the purpose and changes
  • Code follows project coding standards
  • Self-review of the code has been done
  • Changes have been tested locally
  • Screenshots have been attached (if applicable)
  • Documentation has been updated (if applicable)

Client (if applicable)

  • UI changes look good on all screen sizes and browsers
  • No console errors or warnings
  • User experience and accessibility have been tested
  • Added Storybook stories for new components
  • Components follow design system guidelines (if applicable)

Server (if applicable)

  • Code is performant and follows best practices
  • No security vulnerabilities introduced
  • Proper error handling has been implemented
  • Added tests for new functionality
  • Changes have been tested in different environments (if applicable)

@iam-flo iam-flo self-assigned this Dec 2, 2024
@iam-flo iam-flo linked an issue Dec 2, 2024 that may be closed by this pull request
10 tasks
@github-actions github-actions bot added application-server size:L This PR changes 100-499 lines, ignoring generated files. labels Dec 2, 2024
@github-actions github-actions bot added client size:XL This PR changes 500-999 lines, ignoring generated files. and removed autocommit-openapi size:L This PR changes 100-499 lines, ignoring generated files. labels Dec 2, 2024
@github-actions github-actions bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Dec 30, 2024
@iam-flo iam-flo force-pushed the 199-visualize-pull-requests-description-bad-practices-in-a-dashboard branch from 0f2385d to 9e0925a Compare December 30, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
application-server client size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Visualize pull requests description bad practices in a dashboard
1 participant