search

AlexSim93 / pull-request-analytics-action

Provides informative reports on team and developer metrics, based on data from pull requests and code reviews
MIT License
110 stars 10 forks source link

Feature: Correlation Between Lead Time and Pull Request Size #54

Closed AlexSim93 closed 3 days ago

AlexSim93 commented 3 days ago

Pull Request

Description

Type of Change

How Has This Been Tested?

Used for different months and teams.

Checklist:

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 days ago

Walkthrough

The pull request introduces substantial modifications to the Collection type in src/converters/types.ts, adding new optional properties for tracking pull request metrics. A new function, calcPRsize, is introduced to compute pull request sizes, utilizing a constant deletionCoefficient. The getPullRequestSize function is updated to leverage this new utility. Additional changes include enhancements to the preparePullRequestStats and preparePullRequestTimeline functions, which now incorporate new metrics and refined calculations. New utility functions for generating charts and reports are also added, improving the overall functionality of the codebase.

Changes

File Path Change Summary
src/converters/types.ts - Added properties: unreviewed?: number, unapproved?: number, sizes?: Record<string, {...} in Collection type.
src/converters/utils/calculations/calcPRsize.ts - Added method: calcPRsize(additions: number | undefined, deletions: number | undefined).
src/converters/utils/calculations/constants.ts - Added constant: export const deletionCoefficient = 0.2;.
src/converters/utils/calculations/getPullRequestSize.ts - Updated method to use calcPRsize: getPullRequestSize(additions: number | undefined, deletions: number | undefined).
src/converters/utils/calculations/index.ts - Added export: deletionCoefficient from ./constants.
src/converters/utils/preparePullRequestStats.ts - Updated function to include calculations for sizes property in collection. Signature: export const preparePullRequestStats = (collection: Collection).
src/converters/utils/preparePullRequestTimeline.ts - Modified to use getPullRequestSize and calcPRsize. Updated handling of timeToReview and timeToApprove. Added properties: unreviewed and unapproved. Signature: export const preparePullRequestTimeline.
src/createOutput.ts - Added functionality to post comments with correlation graphs if SHOW_CORRELATION_GRAPHS is true.
src/view/utils/constants.ts - Updated constant: additionsDeletionsHeader to "Additions / Deletions". Added constants: unreviewedPrsHeader and unapprovedPrsHeader.
src/view/utils/createConfigParamsCode.ts - Added parameter: "SHOW_CORRELATION_GRAPHS" in the report settings.
src/view/utils/createDependencyMarkdown.ts - Added method: createDependencyMarkdown(data, users, references).
src/view/utils/createReviewTable.ts - Modified PR size calculation formula to additions + deletions * 0.2.
src/view/utils/createSizeDependencyXYChart.ts - Added method: createSizeDependencyXYChart(data, type, user).
src/view/utils/createTimelineMonthComparisonChart.ts - Enhanced filtering logic for dates in createTimelineMonthComparisonChart.
src/view/utils/createTotalTable.ts - Added headers: unreviewedPrsHeader, unapprovedPrsHeader. Modified PR size calculation formula.
src/view/utils/index.ts - Added export: createDependencyMarkdown from ./createDependencyMarkdown.

Possibly related PRs

Poem

🐰 In the burrow where code does play,
New metrics hop and dance today.
With sizes tracked and graphs to show,
Pull requests bloom, watch them grow!
Unreviewed and unapproved, we cheer,
A brighter path for all, oh dear! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` or `@coderabbitai review` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
AlexSim93 commented 3 days ago

@coderabbitai review

coderabbitai[bot] commented 3 days ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.