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.

Sign up for GitHub

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
Open

Readme Updated for firefox User #203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 51 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Scrum Helper

**Scrum Helper** is a Chrome extension that simplifies writing development reports by auto-filling content based on your Git activity. Just enter your GitHub username, select a date range, and choose your preferences, the extension automatically fetches your commits, pull requests, issues, and code reviews via the GitHub API and generates a pre-filled report that you can edit as needed. While currently focused on Git-based workflows, Scrum Helper is designed to expand to other platforms in the future.
Expand All @@ -17,26 +16,34 @@
### For Chrome:

1. Clone this repository to your local machine.
2. Go to `chrome://extensions` on your chrome browser.
2. Go to `chrome://extensions` on your Chrome browser.
3. Enable Developer Mode (toggle in the top-right) if not already.
4. Click Load unpacked and select the `src` folder inside the cloned repo
5. Click the Scrum Helper icon on your browser toolbar
4. Click Load unpacked and select the `src` folder inside the cloned repo.
5. Click the Scrum Helper icon on your browser toolbar.
6. Fill in your settings in the popup (GitHub username, date range, etc.)

<!-- ### For Firefox:
### For Firefox:

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.
Comment on lines 27 to +31
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.

6. Click the Scrum Helper icon on your browser toolbar.
7. Fill in your settings in the popup (GitHub username, date range, etc.)

**Note for Firefox users:** The extension will be automatically removed when you close Firefox. You'll need to reload it each time you start a new browser session by repeating steps 2-4.

**Persistence Note:**

- If you need the extension to persist between sessions, use [Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) or [Nightly](https://www.mozilla.org/en-US/firefox/channel/desktop/). You can enable unsigned extension persistence by setting `xpinstall.signatures.required` to `false` in `about:config`.
- For permanent installation and distribution, you must [sign your extension](https://extensionworkshop.com/documentation/publish/signing-and-distribution-overview/) via Mozilla Add-ons (AMO).

**Note for Firefox users:** The extension will be automatically removed when you close Firefox. You'll need to reload it each time you start a new browser session by repeating steps 2-5.
**Compatibility Notes:**

**Persistence Note:** If you need the extension to persist between sessions, use Firefox Developer Edition. You can enable persistence by setting `xpinstall.signatures.required` to `false` in the browser's configuration. -->
- Scrum Helper uses the `chrome.*` API namespace, which is supported in Firefox for most WebExtension APIs. Firefox provides compatibility for these APIs, but some advanced or Chrome-only APIs may not be available. For most users, all major features will work as expected in Firefox.
- If you encounter issues, consult the [MDN WebExtension compatibility guide](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Chrome_incompatibilities).
- For advanced cross-browser compatibility, you may use the [webextension-polyfill](https://github.com/mozilla/webextension-polyfill), but it is not required for standard usage of Scrum Helper.

## Usage

Expand All @@ -56,27 +63,29 @@
### New Features

1. **Standalone Popup Interface**

- Generate reports directly from the extension popup
- Live preview of the report before sending
- Rich text formatting with clickable links
- Copy report to clipboard with proper formatting

2. **Advanced Repository Filtering**
* Select specific repositories to include in your report for a more focused summary.
* Easily search and manage your repository list directly within the popup.
* *Requires a GitHub token to fetch your repositories.*
2. **Advanced Repository Filtering**

- Select specific repositories to include in your report for a more focused summary.
- Easily search and manage your repository list directly within the popup.
- _Requires a GitHub token to fetch your repositories._

3. **Include Commits on Existing PRs**
* Option to include recent commits made to pull requests that were opened *before* the selected date range.
* Provides a more detailed and accurate view of your work on long-running PRs.
* *Requires a GitHub token.*
3. **Include Commits on Existing PRs**
- Option to include recent commits made to pull requests that were opened _before_ the selected date range.
- Provides a more detailed and accurate view of your work on long-running PRs.
- _Requires a GitHub token._

### Usage Standalone

- Click on `GENERATE` button to generate the scrum preview.
- Edit it in the window.
- Copy the rich HTML using the `COPY` button.


## Screenshots

![SCRUM](docs/images/scrum.png)
Expand All @@ -99,45 +108,46 @@ $ npm install

1. **Install the Extension**

* For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
- For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
<!-- * For Firefox: Load it as a temporary add-on through `about:debugging` as described above. -->


2. **Build the Extension**
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
- For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
<!-- * For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension. -->

3. **How to Obtain a GitHub Personal Access Token**

- To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token.

#### Steps to Generate a Token

1. **Go to GitHub Developer Settings:**
Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account.
Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account.

2. **Choose Token Type:**

- Select **"Personal access tokens (classic)"**.

2. **Choose Token Type:**
- Select **"Personal access tokens (classic)"**.
3. **Generate a New Token:**

3. **Generate a New Token:**
- Click **"Generate new token"**.
- Give your token a descriptive name (e.g., "Scrum Helper Extension").
- Set an expiration date if desired.
- Click **"Generate new token"**.
- Give your token a descriptive name (e.g., "Scrum Helper Extension").
- Set an expiration date if desired.

4. **Create and Copy the Token:**
- Click **"Generate token"** at the bottom.
- **Copy the token** and save it securely. You will not be able to see it again!
4. **Create and Copy the Token:**

5. **Paste the Token in Scrum Helper:**
- Open the Scrum Helper extension popup.
- Paste your token into the "GitHub Token" field.
- Click **"Generate token"** at the bottom.
- **Copy the token** and save it securely. You will not be able to see it again!

5. **Paste the Token in Scrum Helper:**

- Open the Scrum Helper extension popup.
- Paste your token into the "GitHub Token" field.

> **Keep your token secret!** Never share it or commit it to public repositories.

**Why use a token?**
GitHub tokens allow the extension to make authenticated requests, increasing your API rate limit and enabling access to private repositories if you grant those permissions.


## About contributing

- Follow the Issues and PRs templates as far as possible.
Expand Down