Skip to content

Commit 292a3f1

Browse files
vedansh-5vedansh-5
authored
Merge branch 'master' into optapi
2 parents 3f33131 + 63c1916 commit 292a3f1

15 files changed

+510
-178
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
### Steps to Reproduce
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
### Expected Behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
### Actual Behavior
24+
A clear and concise description of what actually happened.
25+
26+
### Screenshots
27+
If applicable, add screenshots to help explain your problem.
28+
29+
### Additional Context
30+
Add any other context about the problem here.
31+
32+
---
33+
34+
## Contribution Checklist
35+
- [ ] I have searched existing issues to ensure this bug hasn't been reported
36+
- [ ] I have provided clear reproduction steps
37+
- [ ] I have included relevant environment details
38+
- [ ] I have described both expected and actual behavior

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature or Enhancement Request
3+
about: Suggest a new feature or improvement to existing functionality
4+
title: '[Enhancement]: <short description>'
5+
labels: ['enhancement']
6+
assignees: ''
7+
---
8+
9+
## Enhancement Summary
10+
A clear and concise description of the enhancement or feature you'd like to see.
11+
12+
### Motivation
13+
Why is this feature needed? What problem does it solve or what value does it add?
14+
15+
### Proposed Solution
16+
Describe your idea or how you would like it to work.
17+
18+
### Alternatives Considered
19+
Have you thought of any other ways to solve the problem?
20+
21+
### Screenshots / Mockups
22+
If applicable, add visuals or examples of how this could look/work.
23+
24+
### Additional Context
25+
Any other relevant information or use cases.
26+
27+
---
28+
29+
## Contribution Checklist
30+
- [ ] I have checked existing enhancement requests
31+
- [ ] I have clearly described the proposed change
32+
- [ ] I have explained the motivation and context
33+
- [ ] I am willing to help implement this feature (optional)

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
1-
Fixes issue #[Add issue number here. If you do not solve the issue entirely, please change the message e.g. "First steps for issues #IssueNumber]
1+
### 📌 Fixes
22

3-
Changes: [Add here what changes were made in this issue and if possible provide links.]
3+
Fixes #<issue-number> (Use "Fixes", "Closes", or "Resolves" for automatic closing)
44

5-
Screenshots for the change:
5+
---
6+
7+
### 📝 Summary of Changes
8+
9+
- Short description of what was changed
10+
- Include links to related issues/discussions if any
11+
12+
---
13+
14+
### 📸 Screenshots / Demo (if UI-related)
15+
16+
_Add screenshots, video, or link to deployed preview if applicable_
17+
18+
---
19+
20+
### ✅ Checklist
21+
22+
- [ ] I’ve tested my changes locally
23+
- [ ] I’ve added tests (if applicable)
24+
- [ ] I’ve updated documentation (if applicable)
25+
- [ ] My code follows the project’s code style guidelines
26+
27+
---
28+
29+
### 👀 Reviewer Notes
30+
31+
_Add any special notes for the reviewer here_

‎.github/release-drafter.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name-template: 'v$RESOLVED_VERSION 🌈'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
categories:
4+
- title: '🚀 Features'
5+
labels:
6+
- 'feature'
7+
- 'enhancement'
8+
- title: '🐛 Bug Fixes'
9+
labels:
10+
- 'fix'
11+
- 'bugfix'
12+
- 'bug'
13+
- title: '🧰 Maintenance'
14+
labels: 'chore'
15+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
16+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
17+
version-resolver:
18+
major:
19+
labels:
20+
- 'major'
21+
minor:
22+
labels:
23+
- 'minor'
24+
patch:
25+
labels:
26+
- 'patch'
27+
default: patch
28+
template: |
29+
## Changes
30+
31+
$CHANGES

‎.github/workflows/release-drafter.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- master
8+
9+
# pull_request event is required only for autolabeler
10+
pull_request:
11+
# Only following types are handled by the action, but one can default to all as well
12+
types: [opened, reopened, synchronize]
13+
# pull_request_target event is required for autolabeler to support PRs from forks
14+
# pull_request_target:
15+
# types: [opened, reopened, synchronize]
16+
17+
permissions:
18+
contents: read
19+
20+
jobs:
21+
update_release_draft:
22+
permissions:
23+
# write permission is required to create a github release
24+
contents: write
25+
# write permission is required for autolabeler
26+
# otherwise, read permission is required at least
27+
pull-requests: write
28+
runs-on: ubuntu-latest
29+
steps:
30+
# (Optional) GitHub Enterprise requires GHE_HOST variable set
31+
#- name: Set GHE_HOST
32+
# run: |
33+
# echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
34+
35+
# Drafts your next Release notes as Pull Requests are merged into "master"
36+
- uses: release-drafter/[email protected]
37+
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
38+
# with:
39+
# config-name: my-config.yml
40+
# disable-autolabeler: true
41+
env:
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎README.md

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22

33
**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.
44

5-
65
![SCRUMLOGO](docs/images/scrumhelper-png.png)
76

87
## Features
98

10-
- Fetches your GitHub PRs, Issues, and reviewed PRs
11-
- Auto-generates scrum updates
12-
- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows
9+
- Fetches your GitHub PRs, Issues, and reviewed PRs
10+
- Auto-generates scrum updates
11+
- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows
1312

1413
## How to install
1514

@@ -21,16 +20,31 @@
2120
6. Fill in your settings in the popup (GitHub username, date range, etc.)
2221

2322
## Usage
24-
### For Google Groups:
23+
24+
### For Google Groups:
25+
2526
- Open Google Groups New Topic
2627
- Start a New Conversation
2728
- Refresh the page to apply the Scrum Helper settings
2829
- Use the pre-filled scrum and edit as needed
2930

3031
### For Gmail, Yahoo, and Outlook:
31-
- Open the Compose window.
32+
33+
- Open the Compose window.
3234
- Ensure the Scrum Helper settings are applied (follow step 6 above)
33-
- The extension will prefill scrum content for you to edit
35+
- The extension will prefill scrum content for you to edit
36+
37+
### New Features
38+
1. **Standalone Popup Interface**
39+
- Generate reports directly from the extension popup
40+
- Live preview of the report before sending
41+
- Rich text formatting with clickable links
42+
- Copy report to clipboard with proper formatting
43+
44+
### Usage Standalone
45+
- Click on `GENERATE` button to generate the scrum preview.
46+
- Edit it in the window.
47+
- Copy the rich HTML using the `COPY` button.
3448

3549
## New Features
3650
- The extension now uses parallel modern API requests along with data caching with a TTL(Time to Live) of 10 minutes.
@@ -44,12 +58,52 @@ $ git clone https://github.com/fossasia/scrum_helper/
4458
$ cd scrum_helper
4559
$ npm install
4660
```
61+
4762
## Screenshots
63+
4864
![SCRUM](/docs/images/scrum.png)
4965

5066
![POPUP](docs/images/popup.png)
5167

68+
![STANDALONE](docs/images/standalone.png)
69+
70+
## Using Scrum Helper with Your Own GitHub Organization
71+
72+
Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organization. You can easily configure it to fetch and generate SCRUM reports for your own GitHub organization or repositories.
73+
74+
### Steps to Set It Up for Your Organization
75+
76+
1. **Install the Extension**
77+
78+
- Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
79+
80+
2. **Update the Organization**
81+
82+
- Currently, the extension uses `org:fossasia` to fetch GitHub issues and PRs.
83+
- To make it work with your GitHub organization:
84+
- Open `scrumHelper.js` (or wherever the GitHub API URLs are defined).
85+
- Replace:
86+
```js
87+
+org:fossasia+
88+
```
89+
with:
90+
```js
91+
+org:your-org-name+
92+
```
93+
**Example**
94+
![Code Snippet ](<Screenshot 2025-05-30 205822.png>)
95+
96+
3. **Build the Extension**
97+
98+
- Save your changes.
99+
- Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
100+
101+
4. **Get Customized SCRUM Reports**
102+
- The reports will now be generated using contributions from your organization.
103+
104+
52105
## About contributing
106+
53107
- Follow the Issues and PRs templates as far as possible.
54108
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
55109
- Before making a PR, ensure your code is properly formatted and linted:

‎Screenshot 2025-05-30 205822.png

34.6 KB
Loading

‎docs/images/standalone.png

68.4 KB
Loading

‎src/index.css

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,25 @@ li {
9595
100% { transform: rotate(360deg); }
9696
}
9797

98+
#scrumReport {
99+
border: 1px solid #ccc;
100+
padding: 10px;
101+
min-height: 200px;
102+
max-height: 400px;
103+
overflow-y: auto;
104+
background-color: white;
105+
}
106+
107+
#scrumReport:focus {
108+
outline: none;
109+
border-color: #26a69a;
110+
}
111+
112+
#scrumReport a {
113+
color: #26a69a;
114+
text-decoration: none;
115+
}
116+
117+
#scrumReport a:hover {
118+
text-decoration: underline;
119+
}

0 commit comments

Comments
 (0)