Skip to content

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

Merged
merged 1 commit into from
Jun 1, 2025

Conversation

Preeti9764
Copy link
Contributor

@Preeti9764 Preeti9764 commented May 30, 2025

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:

  • Add a new README section detailing steps to set up Scrum Helper with a custom GitHub organization by editing the org: parameter in API calls

Copy link
Contributor

sourcery-ai bot commented May 30, 2025

Reviewer's Guide

This 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

Change Details Files
Added instructions for configuring a custom GitHub organization
  • Introduced “Using Scrum Helper with Your Own GitHub Organization” section
  • Outlined steps to update the org name in the API query code
  • Provided example snippet and rebuild instructions
README.md
Refined markdown formatting in existing sections
  • Removed extra blank lines and standardized list markers
  • Consistent indentation under headings
  • Adjusted spacing around code blocks and images
README.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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+ with org: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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

## Screenshots

![SCRUM](/docs/images/scrum.png)
Copy link
Contributor

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'.

Suggested change
![SCRUM](/docs/images/scrum.png)
![Example Scrum report generated by SCRUM Helper](/docs/images/scrum.png)

@hpdang hpdang self-requested a review June 1, 2025 07:02
@hpdang hpdang requested a review from vedansh-5 June 1, 2025 07:36
@hpdang hpdang merged commit 865ebf8 into fossasia:master Jun 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants