|
| 1 | +# GitHub Workbench |
| 2 | + |
| 3 | +A Chrome extension that streamlines GitHub development workflows by providing smart automation tools for common development tasks. |
| 4 | + |
| 5 | +## Current Features |
| 6 | + |
| 7 | +- **Smart Branch Name Generator**: Automatically generates standardized branch names from GitHub issues |
| 8 | + - Converts issue titles into git-friendly branch names |
| 9 | + - One-click copy to clipboard |
| 10 | + - Maintains consistent naming conventions across your team |
| 11 | + |
| 12 | +## Installation Steps |
| 13 | + |
| 14 | +1. Download the extension |
| 15 | + - Go to the [Releases](https://github.com/yourusername/yourrepo/releases) page |
| 16 | + - Download the latest release ZIP file |
| 17 | + |
| 18 | +2. Unzip the extension |
| 19 | + - Locate the downloaded ZIP file |
| 20 | + - Right-click and select "Extract All..." (Windows) or double-click (Mac) |
| 21 | + - Choose a destination folder for the extracted files |
| 22 | + |
| 23 | +3. Install in Chrome |
| 24 | + - Open Chrome and go to `chrome://extensions/` |
| 25 | + - Enable "Developer mode" using the toggle switch in the top-right corner |
| 26 | + - Click "Load unpacked" |
| 27 | + - Navigate to the folder containing the extracted extension files |
| 28 | + - Select the folder and click "Select" (Windows) or "Open" (Mac) |
| 29 | + |
| 30 | +The extension should now appear in your Chrome toolbar! |
| 31 | + |
| 32 | +## Permissions |
| 33 | + |
| 34 | +This extension requires minimal permissions to enhance your GitHub workflow: |
| 35 | + |
| 36 | +- Clipboard access: Only used to copy generated branch names |
| 37 | +- Active tab access: Required to modify GitHub issue pages |
| 38 | +- GitHub-only: The extension only runs on github.com domains |
| 39 | +- No data collection: Works entirely in your browser with no external connections |
| 40 | + |
| 41 | +## Troubleshooting |
| 42 | + |
| 43 | +- If you don't see the extension, try refreshing the extensions page |
| 44 | +- Make sure you selected the correct folder containing the manifest.json file |
| 45 | +- If you get an error, verify that all files were extracted properly |
0 commit comments