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.
- Automatically fetches your Git activity, including commits, pull requests, issues, and code reviews.
- Currently supports GitHub, with plans to expand to other platforms
- Generates editable scrum updates based on your selected date range
- Integrates directly with compose windows in Google Groups, Gmail, Yahoo Mail, and Outlook
- Clone this repository to your local machine.
- Go to
chrome://extensions
on your chrome browser. - Enable Developer Mode (toggle in the top-right) if not already.
- Click Load unpacked and select the
src
folder inside the cloned repo - Click the Scrum Helper icon on your browser toolbar
- Fill in your settings in the popup (GitHub username, date range, etc.)
- Open Google Groups New Topic
- Start a New Conversation
- Refresh the page to apply the Scrum Helper settings
- Use the pre-filled scrum and edit as needed
- Open the Compose window.
- Ensure the Scrum Helper settings are applied (follow step 6 above)
- The extension will prefill scrum content for you to edit
-
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
-
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.
-
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.
- Click on
GENERATE
button to generate the scrum preview. - Edit it in the window.
- Copy the rich HTML using the
COPY
button.
$ git clone https://github.com/fossasia/scrum_helper/
$ cd scrum_helper
$ npm install
- Install the Extension
- For Chrome: Load it into your browser through Chrome Extension Developer Mode.
-
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 (
-
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.
-
Go to GitHub Developer Settings:
Visit https://github.com/settings/tokens while logged in to your GitHub account. -
Choose Token Type:
- Select "Personal access tokens (classic)".
- 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.
- 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!
- 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. -
- Follow the Issues and PRs templates as far as possible.
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
- Before making a PR, ensure your code is properly formatted and linted:
- Format your code: This command automatically formats your code based on the project's style guidelines.
npm run format
- Check for issues: This command runs the formatter, linter, and import sorting on the requested files to enforce coding standards.
npm run check
- Fix linting errors: If the linter detects fixable issues, this command will automatically apply the necessary corrections.
npm run fix
- Format your code: This command automatically formats your code based on the project's style guidelines.
- If you encounter any bugs, please report them at the Issues page.