Skip to content

Commit f11b51b

Browse files
authored
Merge branch 'master' into standalone
2 parents fd3432c + f09ebdc commit f11b51b

File tree

4 files changed

+103
-18
lines changed

4 files changed

+103
-18
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
1-
**Actual Behaviour**
1+
---
2+
name: Bug Report / Feature Request
3+
about: Report a bug or request a new feature
4+
title: '[Bug/Feature]: <short description>'
5+
labels: ['needs triage']
6+
assignees: ''
7+
---
28

3-
Please state here what is currently happening.
9+
### 🔍 Actual Behaviour
410

5-
**Expected Behaviour**
11+
What is currently happening?
612

7-
State here what the feature should enable the user to do.
13+
### ✅ Expected Behaviour
814

9-
**Screenshots of the issue**
15+
What should ideally happen?
1016

11-
Where-ever possible attach a screenshot of the issue.
17+
### 📸 Screenshots
1218

13-
**Would you like to work on the issue?**
19+
If applicable, add screenshots to help explain the issue.
1420

15-
Please let us know if you can work on it or the issue should be assigned to someone else.
21+
### 🧪 Steps to Reproduce (for bugs)
22+
23+
1. Go to '...'
24+
2. Click on '...'
25+
3. Scroll down to '...'
26+
4. See the error
27+
28+
### 💡 Possible Solution
29+
30+
(Optional) Suggest a fix or reason for the bug.
31+
32+
### 🙋‍♂️ Would You Like to Work on It?
33+
34+
Yes / No

.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_

README.md

Lines changed: 47 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,19 @@
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
3436

3537
### New Features
3638
1. **Standalone Popup Interface**
@@ -51,14 +53,52 @@ $ git clone https://github.com/fossasia/scrum_helper/
5153
$ cd scrum_helper
5254
$ npm install
5355
```
56+
5457
## Screenshots
58+
5559
![SCRUM](/docs/images/scrum.png)
5660

5761
![POPUP](/docs/images/popup.png)
5862

5963
![STANDALONE](docs/images/standalone.png)
6064

65+
## Using Scrum Helper with Your Own GitHub Organization
66+
67+
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.
68+
69+
### Steps to Set It Up for Your Organization
70+
71+
1. **Install the Extension**
72+
73+
- Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
74+
75+
2. **Update the Organization**
76+
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:
81+
```js
82+
+org:fossasia+
83+
```
84+
with:
85+
```js
86+
+org:your-org-name+
87+
```
88+
**Example**
89+
![Code Snippet ](<Screenshot 2025-05-30 205822.png>)
90+
91+
3. **Build the Extension**
92+
93+
- Save your changes.
94+
- Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
95+
96+
4. **Get Customized SCRUM Reports**
97+
- The reports will now be generated using contributions from your organization.
98+
99+
61100
## About contributing
101+
62102
- Follow the Issues and PRs templates as far as possible.
63103
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
64104
- Before making a PR, ensure your code is properly formatted and linted:

Screenshot 2025-05-30 205822.png

34.6 KB
Loading

0 commit comments

Comments
 (0)