Skip to content

Commit 1726255

Browse files
Saksham-SirohiSaksham-Sirohi
authored
Merge branch 'master' into multi-google-user-fix
2 parents 3d323f2 + b2ae50d commit 1726255

File tree

9 files changed

+188
-27
lines changed

9 files changed

+188
-27
lines changed

‎.github/labeler.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Frontend changes
2+
frontend:
3+
- 'src/**/*.html'
4+
- 'src/**/*.css'
5+
6+
# JavaScript changes
7+
javascript:
8+
- 'src/scripts/**/*.js'
9+
- 'src/**/*.js'
10+
11+
# Core functionality
12+
core:
13+
- 'src/scripts/scrumHelper.js'
14+
- 'src/scripts/emailClientAdapter.js'
15+
16+
# Documentation
17+
documentation:
18+
- '**/*.md'
19+
- 'docs/**'
20+
- 'LICENSE'
21+
- 'README.md'
22+
23+
# Configuration files
24+
config:
25+
- '.github/**/*'
26+
- '*.json'
27+
- '*.yml'
28+
- '*.yaml'
29+
- 'package.json'
30+
- 'package-lock.json'
31+
32+
# Browser extension specific
33+
extension:
34+
- 'manifest.json'
35+
- 'src/popup.html'
36+
- 'src/scripts/main.js'
37+
38+
# Testing
39+
testing:
40+
- 'tests/**'
41+
- '**/*.test.js'
42+
- '**/*.spec.js'
43+
44+
# Dependencies
45+
dependencies:
46+
- 'package.json'
47+
- 'package-lock.json'
48+
- 'yarn.lock'
49+
50+
# Additional labels (manually applied, no patterns)
51+
bug: []
52+
codeheat: []
53+
duplicate: []
54+
enhancement: []
55+
good first issue: []
56+
hacktoberfest: []
57+
help wanted: []
58+
invalid: []
59+
question: []
60+
wontfix: []
61+
"Pull requests that update a dependency file": []

‎.github/workflows/labeler.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Auto Labeler
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, synchronize, reopened]
6+
7+
jobs:
8+
label:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/labeler@v4
12+
with:
13+
repo-token: "${{ secrets.GITHUB_TOKEN }}"

‎README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,43 @@
1-
# SCRUM Helper
21

3-
**SCRUM Helper** is a Chrome extension designed to simplify writing scrums in Google Groups for FOSSASIA projects. By adding your GitHub username, date range, and other options, it automatically fetches your PRs, Issues, and reviewed PRs via the GitHub API and pre-fills the scrum. You can then edit the scrum to fit your needs.
2+
# Scrum Helper
3+
4+
**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.
45

56
![SCRUMLOGO](docs/images/scrumhelper-png.png)
67

78
## Features
89

9-
- Fetches your GitHub PRs, Issues, and reviewed PRs
10-
- Auto-generates scrum updates
11-
- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows
10+
- Automatically fetches your Git activity, including commits, pull requests, issues, and code reviews.
11+
- Currently supports GitHub, with plans to expand to other platforms
12+
- Generates editable scrum updates based on your selected date range
13+
- Integrates directly with compose windows in Google Groups, Gmail, Yahoo Mail, and Outlook
1214

1315
## How to install
1416

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

26+
### For Firefox:
27+
28+
1. Clone this repository to your local machine.
29+
2. Open Firefox and navigate to `about:debugging`
30+
3. Click on "This Firefox" in the left sidebar
31+
4. Click "Load Temporary Add-on..."
32+
5. Navigate to the `src` folder inside the cloned repo and select the `manifest.json` file
33+
6. The extension will be loaded temporarily and will remain active only for the current browser session
34+
7. Click the Scrum Helper icon on your browser toolbar
35+
8. Fill in your settings in the popup (GitHub username, date range, etc.)
36+
37+
**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.
38+
39+
**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.
40+
2241
## Usage
2342

2443
### For Google Groups:
@@ -35,6 +54,7 @@
3554
- The extension will prefill scrum content for you to edit
3655

3756
### New Features
57+
3858
1. **Standalone Popup Interface**
3959
- Generate reports directly from the extension popup
4060
- Live preview of the report before sending
@@ -56,9 +76,9 @@ $ npm install
5676

5777
## Screenshots
5878

59-
![SCRUM](/docs/images/scrum.png)
79+
![SCRUM](docs/images/scrum.png)
6080

61-
![POPUP](/docs/images/popup.png)
81+
![POPUP](docs/images/popup.png)
6282

6383
![STANDALONE](docs/images/standalone.png)
6484

@@ -70,29 +90,32 @@ Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organ
7090

7191
1. **Install the Extension**
7292

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

7596
2. **Update the Organization**
97+
* Currently, the extension uses `org:fossasia` to fetch GitHub issues and PRs.
98+
* To make it work with your GitHub organization:
99+
* Open `scrumHelper.js` (or wherever the GitHub API URLs are defined).
100+
* Replace:
76101

77-
- Currently, the extension uses `org:fossasia` to fetch GitHub issues and PRs.
78-
- To make it work with your GitHub organization:
79-
- Open `scrumHelper.js` (or wherever the GitHub API URLs are defined).
80-
- Replace:
81102
```js
82103
+org:fossasia+
83104
```
105+
84106
with:
107+
85108
```js
86109
+org:your-org-name+
87110
```
111+
88112
**Example**
89113
![Code Snippet ](<Screenshot 2025-05-30 205822.png>)
90114

91115
3. **Build the Extension**
92-
93-
- Save your changes.
94-
- Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
95-
116+
* Save your changes.
117+
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
118+
* For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension.
96119
4. **Get Customized SCRUM Reports**
97120
- The reports will now be generated using contributions from your organization.
98121

‎docs/images/icon128x128.png

24.4 KB
Loading

‎docs/images/icon128x128.svg

Lines changed: 65 additions & 0 deletions
Loading

‎docs/images/old_icon.png

3.83 KB
Loading

‎package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "scrum_helper_extension",
2+
"name": "scrum-helper",
33
"version": "1.0.0",
4-
"description": "This extension helps in writing Scrums in google groups, particularly related to FOSSASIA. It converts a link to a github PR or an Issue to display the PR or the Issue's name along with the link to it.",
4+
"description": "This extension simplifies writing development reports by auto-filling content based on your Git activity.",
55
"repository": {
66
"type": "git",
77
"url": "git+https://github.com/fossasia/scrum_helper.git"
@@ -16,8 +16,8 @@
1616
"google groups",
1717
"fossasia"
1818
],
19-
"author": "hkedia321",
20-
"license": "ISC",
19+
"author": "FOSSASIA",
20+
"license": "LGPL-2.1",
2121
"bugs": {
2222
"url": "https://github.com/fossasia/scrum_helper/issues"
2323
},

‎src/icons/icon.png

20.5 KB
Loading

‎src/manifest.json

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"manifest_version": 3,
3-
"name": "Scrum Helper Extension",
3+
"name": "Scrum Helper",
44
"version": "1.0",
5-
"description": "This extension helps in writing Scrums in Google Groups, particularly related to FOSSASIA.",
5+
"description": "This extension simplifies writing development reports by auto-filling content based on your Git activity.",
66
"action": {
77
"default_popup": "popup.html",
8-
"default_title": "SCRUM Helper"
8+
"default_title": "Scrum Helper"
99
},
1010
"icons": {
1111
"96": "icons/icon.png",
@@ -17,15 +17,15 @@
1717
"content_scripts": [
1818
{
1919
"matches": [
20-
"*://groups.google.com/forum/*",
20+
"*://groups.google.com/forum/*",
2121
"*://groups.google.com/g/*",
2222
"*://groups.google.com/u/*/g/*",
2323
"*://mail.google.com/*",
2424
"*://outlook.live.com/*",
2525
"*://outlook.office.com/*",
26-
"*://mail.yahoo.com/*"
26+
"*://mail.yahoo.com/*"
2727
],
28-
"js": ["scripts/jquery-3.2.1.min.js", "scripts/emailClientAdapter.js", "scripts/scrumHelper.js"]
28+
"js": ["scripts/jquery-3.2.1.min.js", "scripts/emailClientAdapter.js", "scripts/scrumHelper.js"]
2929
}
3030
],
3131

@@ -46,7 +46,6 @@
4646
"notifications"
4747
],
4848
"host_permissions": [
49-
"<all_urls>",
5049
"*://*.google.com/*",
5150
"*://*.outlook.live.com/*",
5251
"*://*.office.com/*",

0 commit comments

Comments
 (0)