UI extension, standalone scrum report #76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
Reviewer's Guide by SourceryThis pull request introduces a standalone scrum report feature with live preview, GitHub data fetching, and Markdown link conversion. It enhances the user experience by providing a WYSIWYG preview and ensuring the copied text is in a format suitable for platforms that support Markdown. The pull request also includes improvements to GitHub data fetching and updates the README with new feature descriptions. Sequence diagram for generating scrum report in popupsequenceDiagram
participant User
participant Popup
participant Extension
participant GitHub API
User->>Popup: Opens popup
User->>Popup: Enters GitHub username
User->>Popup: Clicks 'Generate Report'
Popup->>Extension: Calls generateScrumReport()
Extension->>Extension: allIncluded('popup')
Extension->>GitHub API: Fetches issues and PRs
GitHub API-->>Extension: Returns data
Extension->>Extension: Processes data and generates HTML report
Extension->>Popup: Updates scrumReport div with HTML content
Popup->>User: Displays report preview
Sequence diagram for copying scrum report to clipboardsequenceDiagram
participant User
participant Popup
participant Extension
User->>Popup: Clicks 'Copy Report'
Popup->>Extension: Handles copyReport()
Extension->>Extension: Converts HTML links to Markdown
Extension->>Extension: Removes state buttons
Extension->>Extension: Replaces <br> with \n
Extension->>Extension: Adds '- ' to list items
Extension->>Extension: Removes <ul> tags
Extension->>Extension: Trims whitespace
Extension->>Extension: Copies Markdown to clipboard
Extension->>Popup: Displays success message
Popup->>User: Report copied to clipboard
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @vedansh-5 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a more robust error handling strategy for the GitHub API requests, perhaps with retry logic or more informative user feedback.
- The logic for converting HTML to Markdown could be improved to handle more complex HTML structures.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
@sourcery-ai review on actual code |
There was a problem hiding this comment.
Hey @vedansh-5 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider creating a separate function to handle the GitHub API calls to improve readability.
- The logic for generating the scrum report is quite complex; consider breaking it down into smaller, more manageable functions.
Here's what I looked at during the review
- 🟡 General issues: 4 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: Vedansh Saini <[email protected]>
|
@hongquan, I’d really appreciate your feedback on these changes. Also, is there any other platform besides Glitter where I can discuss functionalities and any obstacles I encounter? |
|
@hongquan Follow up on this PR, please have a look whenever you have some free time. Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Standalone Scrum Report with Markdown Link Support
Description
This PR implements a standalone scrum report section as part of the GSoC problem statement. The key features include:
[Title](link)Testing
The feature can be tested by:
This enhancement improves the user experience by providing a WYSIWYG preview while ensuring the copied text is in a format suitable for platforms that support Markdown.
readme.md is also updated listing the new features.
scrumhelper.standalone.mp4
Summary by Sourcery
Implement a standalone scrum report feature in the browser extension with enhanced reporting capabilities, including live preview, GitHub data fetching, and Markdown link conversion.
New Features:
Enhancements:
Documentation:
Tests: