Skip to content

Readme Updated for firefox User #203

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Preeti9764
Copy link
Contributor

@Preeti9764 Preeti9764 commented Jul 14, 2025

📌 Fixes

Fixes #201


📝 Summary of Changes

  • Added steps of insatllation of extension in the firefox browser.

Summary by Sourcery

Update README with detailed Firefox installation instructions and compatibility guidance

Documentation:

  • Add step-by-step instructions for loading the extension in Firefox including notes on temporary loading and persistence
  • Include compatibility notes for chrome.* APIs in Firefox and links for troubleshooting and polyfill use
  • Refine formatting and wording in Chrome installation section and token generation steps

Copy link
Contributor

sourcery-ai bot commented Jul 14, 2025

Reviewer's Guide

This PR enriches the README by standardizing Chrome instructions, introducing detailed, persistent Firefox installation steps and compatibility notes, and cleaning up formatting and typos throughout the document.

File-Level Changes

Change Details Files
Overhauled extension installation instructions
  • Standardized Chrome steps with consistent punctuation and capitalization
  • Replaced minimal Firefox guide with step-by-step load process, persistence notes, and compatibility guidance
  • Added links to Firefox Developer Edition, AMO signing requirements, and MDN compatibility resources
README.md
Cleaned up formatting and fixed typos
  • Removed commented-out blocks and extraneous hyphens
  • Normalized bullet list indentations and list markers
  • Corrected typos (e.g., “insatllation” → “installation”)
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#201 Update the README to include instructions for Firefox users on how to install and use the Scrum Helper extension.

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:

  • Clean up the leftover HTML comment markers and commented-out blocks in the Firefox section so readers aren’t confused by stray “<!--” markers.
  • Standardize list item punctuation (either end all items with periods or drop them consistently) and ensure heading capitalization is consistent across sections.
  • Consider restructuring the installation guide to consolidate shared steps for Chrome and Firefox and highlight only the differences to reduce redundancy.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Clean up the leftover HTML comment markers and commented-out blocks in the Firefox section so readers aren’t confused by stray “<!--” markers.
- Standardize list item punctuation (either end all items with periods or drop them consistently) and ensure heading capitalization is consistent across sections.
- Consider restructuring the installation guide to consolidate shared steps for Chrome and Firefox and highlight only the differences to reduce redundancy.

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.

@hpdang hpdang requested a review from vedansh-5 July 14, 2025 13:33
@vedansh-5
Copy link
Contributor

@Preeti9764 @hpdang Why do we need this now, considering the extension isn’t usable on Firefox yet?

Comment on lines 27 to +31
1. Clone this repository to your local machine.
2. Open Firefox and navigate to `about:debugging`
3. Click on "This Firefox" in the left sidebar
4. Click "Load Temporary Add-on..."
5. Navigate to the `src` folder inside the cloned repo and select the `manifest.json` file
6. The extension will be loaded temporarily and will remain active only for the current browser session
7. Click the Scrum Helper icon on your browser toolbar
8. Fill in your settings in the popup (GitHub username, date range, etc.)
2. Open Firefox and navigate to `about:debugging#/runtime/this-firefox` (or `about:debugging` > "This Firefox").
3. Click "Load Temporary Add-on...".
4. Navigate to the `src` folder inside the cloned repo and select the `manifest.json` file.
5. The extension will be loaded temporarily and will remain active only for the current browser session.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image I get this error.

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.

Update README to include instructions for using Scrum Helper on Firefox
2 participants