Enhance Documentation with JSDoc for ContributorMetric and BurnoutReport

[tmdeveloper007]

Summary of What Has Been Done

Added JSDoc documentation to the exported symbols in services/github/burnout-analyzer.ts as described in #8398.

Changes Made

• Added JSDoc comments to exported types and functions
• All comments follow the established pattern in the codebase

Impact it Made

• Improves developer experience with inline documentation
• Makes the module consistent with other well-documented utilities
• Reduces onboarding friction for new contributors

Note

Please assign this PR to the tmdeveloper007 account.

Closes #8398

[vercel]

Someone is attempting to deploy a commit to the jhasourav07's projects Team on Vercel.

A member of the Team first needs to authorize it.

[retenta-bot]

This PR enhances the documentation for the ContributorMetric and BurnoutReport by adding JSDoc comments, which aligns with our ongoing efforts to improve code maintainability and onboarding for new contributors. Similar past decisions have emphasized the importance of clear documentation for usability. Thank you for your contribution, and looking forward to your updates!

[github-actions]

👋 Hey @tmdeveloper007! Thanks for your interest in contributing to CommitPulse! 🙏

Unfortunately, this PR has been automatically closed because you are not assigned to the linked issue #8398 — docs : add JSDoc to exported interfaces in services/github/burnout-analyzer.ts.

To avoid this in the future, please follow these steps:

1. Claim the issue — Comment /claim on #8398 if you are the issue author, or ask a maintainer to /assign you.
2. Wait for confirmation — The bot will confirm your assignment with a ✅ reply.
3. Then open your PR — Link the issue with Fixes #8398 in your description.

💡 You can be assigned to up to 5 open issues at a time. Check your current assignments before claiming a new one.

We look forward to your contribution once you're assigned! 🚀