Skip to content

A simple extension for developers to track GitHub pull requests without leaving their browser.

License

Notifications You must be signed in to change notification settings

codebyrpp/PRScout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PRScout icon prscout

Motivation 💡

I've found that managing pull requests efficiently is important for my own productivity and collaboration with others on GitHub. That's why I'm working on this personal project - to create a tool that provides actionable notifications for pull requests, with organization features inspired by Arc Live Folders, and seamless integration with my browser's bookmarks.

Overview 📖

PRScout is a browser extension for Chrome and Firefox browsers that I built to solve my own workflow challenges. It notifies you when a pull request is assigned to you, and helps you organize, track, and manage your PRs directly from your browser.

Features 🚀

  • Notifications: Get notified when PRs are assigned to you
  • Multi-category PR Management: View PRs assigned to you, created by you, requesting your review, and mentioning you
  • Smart Bookmarks Integration: Automatic bookmark creation/removal in a dedicated folder
  • Theme Support: Light, dark, and system preference themes
  • Cross-browser Compatibility: Works on Chrome, Firefox, and other Chromium and Firefox-based browsers
  • Configurable Polling: Adjust notification frequency to your needs

Installation 📦

From Browser Extension Stores

Coming soon - extension will be available on Chrome Web Store and Firefox Add-ons

Manual Installation (Development)

Chrome/Edge/Chromium-based browsers:

  1. Clone this repository: git clone https://github.com/codebyrpp/PRScout.git
  2. Open chrome://extensions/ in your browser
  3. Enable "Developer mode" (toggle in top right)
  4. Click "Load unpacked"
  5. Select the extension/ folder from the cloned repository

Firefox:

  1. Clone this repository: git clone https://github.com/codebyrpp/PRScout.git
  2. Open about:debugging in Firefox
  3. Click "This Firefox"
  4. Click "Load Temporary Add-on"
  5. Select the extension/manifest.json file

Configuration ⚙️

  1. Get a GitHub Personal Access Token:

    • Go to GitHub → Settings → Developer settings → Personal access tokens
    • Generate a fine grained token with Repository Permissions to Pull Requests with read access.
  2. Configure the Extension:

    • Click the PRScout icon in your browser toolbar
    • Click the settings icon or "Open Options"
    • Enter your GitHub Personal Access Token
    • Adjust polling interval as needed (default: 60 seconds)
    • Choose your preferred theme

Development 🛠️

Prerequisites

  • Git
  • Chrome or Firefox browser
  • GitHub Personal Access Token (PAT)

Quick Start

# Clone the repository
git clone https://github.com/codebyrpp/PRScout.git
cd PRScout

# Load the extension in your browser (see Installation section above)

Project Structure

PRScout/
├── extension/           # Main extension files
│   ├── manifest.json   # Extension manifest
│   ├── popup.html     # Popup interface
│   ├── popup.js       # Popup logic
│   ├── background.js  # Background service worker
│   ├── api.js        # GitHub API integration
│   └── styles/        # CSS with theme support
├── docs/              # Documentation
├── README.md
└── CONTRIBUTING.md    # Contributing guidelines

Architecture

  • Manifest V3 compliant browser extension
  • Template+cloneNode pattern for dynamic content
  • CSS variables for comprehensive theming
  • Modular JavaScript with clear separation of concerns
  • GitHub API integration with rate limiting and error handling

Built with 💛

Contributing 🤝

I welcome contributions from anyone interested in improving PRScout! Whether you're fixing bugs, adding features, improving documentation, or suggesting enhancements - all help is appreciated.

Quick Contributing Guide

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes following the code style guidelines
  4. Test thoroughly in both Chrome and Firefox
  5. Submit a pull request

For detailed contributing guidelines, please see CONTRIBUTING.md.

Note: This is a personal project, so please be patient with response times. I'll do my best to review contributions and provide feedback as time allows!

Code Style

  • Use CSS variables from styles/theme.css for all colors
  • Follow template+cloneNode pattern for dynamic HTML
  • Use modern ES6+ JavaScript with async/await
  • Write descriptive variable and function names
  • Follow conventional commit format

License 📄

This project is open source and available under the MIT License.

Support 💬


Star this repository if you find PRScout useful!

About

A simple extension for developers to track GitHub pull requests without leaving their browser.

Topics

Resources

License

Contributing

Stars

Watchers

Forks