-
Notifications
You must be signed in to change notification settings - Fork 80
docs: Add instructions for configuring Scrum Helper with custom GitHub organizations #96
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
Conversation
Reviewer's GuideThis PR updates the README to include a new section that instructs users on how to configure Scrum Helper for any GitHub organization by modifying the API query settings, and also applies minor markdown formatting adjustments for consistency. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @Preeti9764 - I've reviewed your changes - here's some feedback:
- Remove the diff artifact plus signs from the code snippet (e.g., replace
+org:fossasia+
withorg:fossasia
) so it shows valid JS syntax. - Add the referenced screenshot under docs/images and update the markdown link to point to the correct file path instead of
<Screenshot 2025-05-30 205822.png>
.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: 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.
## Screenshots | ||
|
||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Improve image alt text for Scrum example screenshot.
Use a more descriptive alt text, e.g., 'Example Scrum report generated by SCRUM Helper'.
 | |
 |
Fixes issue #95
This PR updates the README.md to include a new section that explains how users can configure the Scrum Helper extension to work with any GitHub organization, not just FOSSASIA.
Changes: >Added setup instructions for customizing the organization name in API queries.
>Helps developers from other organizations adopt the extension more easily.
Summary by Sourcery
Documentation:
org:
parameter in API calls