linear-and-github-extension

Linear And GitHub Extension
LAGE

Linear And GitHub Extension is an open-source MIT-licensed Chrome browser extension designed to "link" Linear and GitHub web pages information. LAGE will generate cross-site sections that aims to let you easily check issues and PRs relations.

🌟 Features

• Seamless Integration: Automatically detects Linear issue codes in GitHub pull requests and compare views
• Real-time Information: Display Linear issue details directly on GitHub pages without switching tabs
• Rich Issue Details: View issue status, priority, assignee, estimates, and more
• Beautiful UI: Clean and intuitive interface that matches GitHub’s design language
• Privacy-First: Your Linear API key is stored locally using Chrome’s secure storage
• Open Source: MIT-licensed and community-driven development

📋 Table of Contents

• Installation
• Setup
• Usage
• Development
• Building
• Contributing
• Documentation
• Support
• License

🚀 Installation

Quick Install: Visit the Chrome Web Store and click “Add to Chrome”.

Manual Installation: Download from GitHub Releases and load as unpacked extension.

For detailed installation instructions and troubleshooting, see the FAQ.

⚙️ Setup

After installation, you need to configure your Linear API key:

1. Click the LAGE extension icon and open Settings
2. Generate your Linear API key - see the Linear API Key Setup Guide for detailed instructions
3. Paste your API key in LAGE settings and save

Important: Your API key is stored securely using Chrome’s Storage Sync API and is never shared with any external services. See our Privacy Policy for details.

💡 Usage

LAGE works automatically on:

• GitHub Pull Requests: github.com/owner/repo/pull/123
• GitHub Compare Views: github.com/owner/repo/compare/main...feature?expand=1

LAGE scans PR titles, descriptions, and commit messages for Linear issue codes (format: PROJ-123) and displays detailed issue information directly on the page.

For more details about features and functionality, see the FAQ.

🛠️ Development

Quick Start

# Clone and install
git clone https://github.com/nelsondaza/linear-and-github-extension.git
cd linear-and-github-extension
pnpm install --frozen-lockfile
pnpm prepare

# Start development
pnpm dev
# Load build/chrome-mv3-dev in Chrome (chrome://extensions/)

Code Quality

pnpm lint        # Run ESLint
pnpm lint:tsc    # Run TypeScript type checking
pnpm pretty      # Format code with Prettier

For comprehensive development guidelines, including coding standards, commit conventions, and PR process, see CONTRIBUTING.md.

🏗️ Building

# Development build with hot reload
pnpm dev

# Production build
pnpm build

# Create distribution ZIP
pnpm package

Build output: build/chrome-mv3-dev/ (development) or build/chrome-mv3-prod/ (production)

For troubleshooting build issues, see TROUBLESHOOTING.md.

🤝 Contributing

We welcome contributions! You can help by:

• 🐛 Reporting bugs in Issues
• 💡 Suggesting features in Discussions
• 💻 Submitting pull requests
• 📝 Improving documentation

Before contributing, please read:

• Contributing Guidelines - Development workflow, coding standards, and PR process
• Code of Conduct - Community guidelines

Security Issues: Report vulnerabilities privately via our Security Policy.

📚 Documentation

• Contributing Guide - How to contribute to LAGE
• FAQ - Frequently asked questions
• Troubleshooting - Common issues and solutions
• Linear API Key Setup - API key generation and configuration
• Privacy Policy - Data handling and privacy
• Security Policy - Vulnerability reporting
• Code of Conduct - Community guidelines
• Changelog - Version history and roadmap

🏗️ Architecture

LAGE is built using a monorepo structure with the following packages:

• @repo/linear: Linear API integration and components
• @repo/github: GitHub-specific UI components
• @repo/ui: Shared UI component library
• @repo/utils: Common utilities and helpers

Tech Stack:

• Plasmo - Browser extension framework
• React - UI library
• TypeScript - Type safety
• Tailwind CSS - Styling
• React Query - Data fetching
• Linear SDK - Linear API client

❓ Support

• Questions? Check the FAQ or GitHub Discussions
• Found a Bug? See Troubleshooting or open an issue
• Need Help? Search existing issues or start a discussion

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with Plasmo
• Linear integration powered by @linear/sdk
• UI components inspired by Headless UI
• Icons from Heroicons

🌐 Links

• Website: https://nelsondaza.github.io/linear-and-github-extension/
• Repository: https://github.com/nelsondaza/linear-and-github-extension
• Chrome Web Store: Coming Soon
• Issues: https://github.com/nelsondaza/linear-and-github-extension/issues
• Discussions: https://github.com/nelsondaza/linear-and-github-extension/discussions

---

Made with ❤️ by Nelson Daza and contributors

This site is open source. Improve this page.