|
1 |
| - |
2 | 1 | # Scrum Helper
|
3 | 2 |
|
4 | 3 | **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.
|
|
72 | 71 | * *Requires a GitHub token.*
|
73 | 72 |
|
74 | 73 | ### Usage Standalone
|
| 74 | + |
75 | 75 | - Click on `GENERATE` button to generate the scrum preview.
|
76 | 76 | - Edit it in the window.
|
77 | 77 | - Copy the rich HTML using the `COPY` button.
|
@@ -99,45 +99,54 @@ $ npm install
|
99 | 99 |
|
100 | 100 | 1. **Install the Extension**
|
101 | 101 |
|
| 102 | + |
102 | 103 | * For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
|
103 | 104 | <!-- * For Firefox: Load it as a temporary add-on through `about:debugging` as described above. -->
|
104 | 105 |
|
105 | 106 |
|
| 107 | + |
| 108 | + |
106 | 109 | 2. **Build the Extension**
|
107 | 110 | * For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
|
108 | 111 | <!-- * For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension. -->
|
109 | 112 |
|
110 | 113 | 3. **How to Obtain a GitHub Personal Access Token**
|
111 | 114 |
|
| 115 | + |
112 | 116 | - To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token.
|
113 | 117 |
|
114 | 118 | #### Steps to Generate a Token
|
115 | 119 |
|
116 | 120 | 1. **Go to GitHub Developer Settings:**
|
117 |
| - Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account. |
| 121 | + Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account. |
118 | 122 |
|
119 |
| - 2. **Choose Token Type:** |
120 |
| - - Select **"Personal access tokens (classic)"**. |
| 123 | + 2. **Choose Token Type:** |
121 | 124 |
|
122 |
| - 3. **Generate a New Token:** |
123 |
| - - Click **"Generate new token"**. |
124 |
| - - Give your token a descriptive name (e.g., "Scrum Helper Extension"). |
125 |
| - - Set an expiration date if desired. |
| 125 | + - Select **"Personal access tokens (classic)"**. |
126 | 126 |
|
127 |
| - 4. **Create and Copy the Token:** |
128 |
| - - Click **"Generate token"** at the bottom. |
129 |
| - - **Copy the token** and save it securely. You will not be able to see it again! |
| 127 | + 3. **Generate a New Token:** |
130 | 128 |
|
131 |
| - 5. **Paste the Token in Scrum Helper:** |
132 |
| - - Open the Scrum Helper extension popup. |
133 |
| - - Paste your token into the "GitHub Token" field. |
| 129 | + - Click **"Generate new token"**. |
| 130 | + - Give your token a descriptive name (e.g., "Scrum Helper Extension"). |
| 131 | + - Set an expiration date if desired. |
| 132 | + |
| 133 | + 4. **Create and Copy the Token:** |
| 134 | + |
| 135 | + - Click **"Generate token"** at the bottom. |
| 136 | + - **Copy the token** and save it securely. You will not be able to see it again! |
| 137 | + |
| 138 | + 5. **Paste the Token in Scrum Helper:** |
| 139 | + |
| 140 | + - Open the Scrum Helper extension popup. |
| 141 | + - Paste your token into the "GitHub Token" field. |
134 | 142 |
|
135 | 143 | > **Keep your token secret!** Never share it or commit it to public repositories.
|
136 | 144 |
|
137 | 145 | **Why use a token?**
|
138 | 146 | 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.
|
139 | 147 |
|
140 | 148 |
|
| 149 | + |
141 | 150 | ## Adding a New Language
|
142 | 151 |
|
143 | 152 | You can add a new language to Scrum Helper for your own use, or contribute it to the project.
|
@@ -168,6 +177,7 @@ If you want to share your translation with others:
|
168 | 177 |
|
169 | 178 | For more details, see the [Chrome i18n documentation](https://developer.chrome.com/docs/extensions/reference/i18n/).
|
170 | 179 |
|
| 180 | + |
171 | 181 | ## About contributing
|
172 | 182 |
|
173 | 183 | - Follow the Issues and PRs templates as far as possible.
|
|
0 commit comments