vee1e/isscope
1
0
Fork 0
mirror of https://github.com/vee1e/isscope.git synced 2026-09-01 18:57:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mirror of https://github.com/vee1e/isscope - AI Powered GitHub Issue Triager
47 commits 5 branches 0 tags 881 KiB
Find a file
vee1e ffe923c34f
docs: add code of conduct
2026-04-28 14:13:34 +05:30
.github add anssh, 2026-04-28 13:56:35 +05:30
.husky chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30
public Initial commit 2026-02-17 07:39:57 +05:30
src Revert "feat(terminal): add aria-label to terminal input for accessibility" 2026-04-20 00:14:56 +05:30
.env.example chore: add .env.example file for environment setup 2026-04-28 14:08:36 +05:30
.gitignore Initial commit 2026-02-17 07:39:57 +05:30
.prettierrc chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30
bun.lock feat: setup vitest and add unit tests for formatter utilities 2026-04-19 21:48:31 +05:30
CODE_OF_CONDUCT.md docs: add code of conduct 2026-04-28 14:13:34 +05:30
CONTRIBUTING.md chore: make PR guidelines clear 2026-04-19 18:58:14 +05:30
eslint.config.js chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30
index.html chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30
LICENSE Initial commit 2026-02-17 07:39:57 +05:30
package.json feat: setup vitest and add unit tests for formatter utilities 2026-04-19 21:48:31 +05:30
README.md fix: prettier complaint 2026-04-22 15:57:07 +05:30
tsconfig.json Initial commit 2026-02-17 07:39:57 +05:30
vercel.json ci: uhg 2026-04-22 16:06:13 +05:30
vite-env.d.ts chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30
vite.config.ts chore: setup pre-commit hooks with husky and lint-staged 2026-04-19 18:41:29 +05:30

README.md

IsScope

IssueScope

IssueScope is a tool for triaging GitHub issues using AI. It analyzes issues to determine their implementation difficulty, required skills, and overall doability, helping contributors find the right issues to work on.

Poster

Tech Stack

This project is built using modern web technologies:

  • Frontend Framework: React 19 + Vite
  • Language: TypeScript
  • Styling: Tailwind CSS v4
  • State Management: Zustand
  • Data Fetching: React Query
  • Animation: Framer Motion
  • Package Manager: Bun

Features

  • AI Analysis: Automatically analyzes issues to estimate complexity, required skills, and newcomer friendliness.
  • Doability Scoring: Ranks issues based on a calculated score (0-100) indicating how actionable and feasible they are.
  • Parallel Processing: Fetches issue details and performs AI analysis in parallel for high throughput.
  • Rich Markdown Support: Renders issue bodies and comments with full Markdown and HTML image support.
  • Keyboard Navigation: Vim-style navigation (j/k, gg, G) and keyboard shortcuts for efficiency.
  • Local Privacy: API keys are stored in memory and never sent to a backend server.

Local Setup Instructions

These instructions have been tested on a clean machine to ensure a reliable setup.

  1. Prerequisites: Make sure you have Bun installed on your machine.

  2. Clone the repository:

    git clone https://github.com/vee1e/isscope.git
cd isscope

  3. Install dependencies:

    bun install

  4. Environment Variables (Optional): Copy the example environment file if you wish to configure default keys (though they can be entered in the UI):

    cp .env.example .env

    (Create .env.example with VITE_GITHUB_TOKEN= and VITE_OPENROUTER_API_KEY= if needed).

  5. Start the development server:

    bun dev

    The application will be available at http://localhost:5173.

Configuration

The application requires API keys to function. You can configure these directly in the UI upon launching the application.

  • OpenRouter API Key: Required for AI analysis.
  • GitHub Token: Optional, but recommended for higher API rate limits.

Usage

  1. Enter a GitHub repository (e.g., owner/repo) or a full URL in the input field.
  2. Click "Configure API Keys" to enter your credentials if you haven't already.
  3. Start the analysis.
  4. Browse the ranked list of issues.
  5. Select an issue to view its full details, including the AI-generated summary and implementation advice.

Contributing

Contributions are welcome! Please read our Contribution Guidelines for details on our code of conduct, pull request process, commit messages, and coding standards.

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/amazing-feature).
  3. Commit your changes following Conventional Commits (git commit -m 'feat: add amazing feature').
  4. Push to the branch (git push origin feature/amazing-feature).
  5. Open a Pull Request.

Contact Channel

If you have questions, suggestions, or need support, please:

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.