Skip to content

Repository files navigation

AOSSIE

Β 

Static Badge

Telegram Badge Β Β  X (formerly Twitter) Badge Β Β  Discord Badge Β Β  Medium Badge Β Β  LinkedIn Badge Β Β  Youtube Badge


AutoInitialIssues

AutoInitialIssues is a powerful GitHub Action designed to automatically populate new repositories with a set of well-defined, categorized initial issues. By leveraging both preset issue banks and AI-powered generation (via GitHub Models), it helps maintainers quickly set up their projects with standard tasks, specialized framework-specific issues, and project-specific requirements.


  • Tiered Execution Modes: Choose between preset (fast), prompt (tailored), and advanced (expert) modes.
  • AI-Powered Generation: Integrates with GitHub Models (GPT-4o) to generate issues based on your project description.
  • Extensive Issue Banks: Access pre-defined issues for frontend, backend, blockchain, ml, mobile, and devops.
  • Framework Specification: Supports specific frameworks like nextjs and express for more relevant task generation.
  • Categorization & Skills: Filter issue generation based on specific project categories and developer skills.

πŸ’» Tech Stack

TODO: Update based on your project

Backend

  • Node.js (v20+)
  • GitHub Actions SDK (@actions/core, @actions/github)

AI/ML

  • GitHub Models API (GPT-4o)
  • Custom Prompt Engineering for Issue Generation

βœ… Project Checklist

TODO: Complete applicable items based on your project type

  • The AI/ML components:
    • LLM/model selection (GPT-4o) and configuration are documented.
    • Prompts and system instructions are version-controlled in src/agent.js.
    • API keys (GitHub Token) and rate limits are managed via GitHub Actions.

πŸ—οΈ Architecture Diagram

TODO: Add your system architecture diagram here

graph TD
    subgraph Tiers [Execution Tiers]
        T1[Tier 1: preset]
        T2[Tier 2: prompt]
        T3[Tier 3: advanced]
    end

    subgraph Inputs [Input Handling]
        I1["Input<br/>preset: 'frontend-nextjs'"]
        I2["Input<br/>project_description: '...'"]
        I3["Input<br/>categories, skills, prompts..."]
    end

    subgraph Logic [Processing Logic]
        L1["Parse + resolve<br/>No AI β€” pure file lookup"]
        L2["GitHub Models AI<br/>Classify + filter via GITHUB_TOKEN"]
        L3["Multi-step AI pipeline<br/>GitHub Models + custom skills"]
    end

    T1 --> I1 --> L1
    T2 --> I2 --> L2
    T3 --> I3 --> L3

    Baseline["issues.json β€” mandatory baseline<br/>agent always includes default issues"]

    L1 --> Baseline
    L2 --> Baseline
    L3 --> Baseline

    Final["GitHub API βž” issues created + self-destruct"]
    Baseline --> Final

    style T1 fill:#1b4a8a,color:#fff
    style T2 fill:#4b3a8a,color:#fff
    style T3 fill:#1b5a4a,color:#fff
    style I1 fill:#1b4a8a,color:#fff
    style I2 fill:#4b3a8a,color:#fff
    style I3 fill:#1b5a4a,color:#fff
    style Baseline fill:#8a5a1b,color:#fff
    style Final fill:#1b5a1b,color:#fff
Loading

You can create architecture diagrams using:

Example structure to include:

  • Frontend components
  • Backend services
  • Database architecture
  • External APIs/services
  • Data flow between components

πŸ”„ User Flow

TODO: Add user flow diagrams showing how users interact with your application

[User Flow Diagram Placeholder]

Key User Journeys

  1. Preset Setup:

    • User adds AutoInitialIssues to their workflow.
    • User specifies mode: preset and preset: frontend-nextjs.
    • Action creates standard issues for Next.js and base project setup.
  2. AI-Tailored Setup:

    • User specifies mode: prompt and provides a project_description.
    • Action calls GitHub Models API to generate context-aware issues.
    • Action creates a tailored set of issues in the repository.

οΏ½πŸ€ Getting Started

Prerequisites

TODO: List what developers need installed

  • Node.js 18+ / Python 3.9+ / Flutter SDK
  • npm / yarn / pnpm
  • [Any specific tools or accounts needed]

Installation

TODO: Provide detailed setup instructions

Configuration

Add the following step to your .github/workflows/main.yml:

- name: Auto Create Initial Issues
  uses: AOSSIE-Org/AutoInitialIssues@v1
  with:
    mode: 'prompt'
    project_description: 'A task management application built with Next.js and Supabase'
    github_token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Description Default
mode Execution mode: preset, prompt, or advanced preset
preset Preset string for Tier 1 (e.g., frontend-nextjs, backend-express) -
project_description Detailed description for AI generation (Required for prompt/advanced) -
project_template Hint for AOSSIE project template stack (e.g., GIFT, AOSS) -
categories Comma-separated categories to prioritize (e.g., frontend,backend) -
skills Comma-separated skills to emphasize (e.g., React,Python) -
max_issues Maximum number of issues to generate 15
label_prefix Prefix to append to all generated issue labels -
github_token GitHub Token for API calls (Requires issues: write scope) ${{ github.token }}

πŸ› οΈ How it Works

1. Mandatory Baseline

Every repository gets a set of foundational issues regardless of the mode selected. These include:

  • Set up project Code of Conduct: Encouraging community standards.
  • Create Contributing Guidelines: Helping new contributors get started.

2. Tiered Generation

  • Preset Mode: Uses pre-defined JSON banks located in issue-banks/. It follows a {category}-{framework} naming convention.
  • Prompt/Advanced Mode: Uses GitHub Models (GPT-4o) to intelligently select and adapt issues from the banks based on your project_description.

3. Issue Banks

The action maintains a library of issues categorized by area and framework:

  • Frontend: default, nextjs
  • Backend: default, express
  • Future Support: Plans for blockchain, ml, mobile, and devops.

πŸš€ Getting Started

Local Development

1. Clone the Repository

git clone https://github.com/AOSSIE-Org/AutoInitialIssues.git
cd AutoInitialIssues

2. Install Dependencies

npm install

3. Build & Test

npm run build
npm test

For more detailed setup instructions, please refer to our Installation Guide.

6. Run Tests

The project uses Jest for unit testing. Tests cover the parser, issue creation, AI agent, and the main entrypoint with all external calls mocked.

npm test

πŸ™Œ Contributing

⭐ Don't forget to star this repository if you find it useful! ⭐

Thank you for considering contributing to this project! Contributions are highly appreciated and welcomed. To ensure smooth collaboration, please refer to our Contribution Guidelines.


✨ Maintainers

TODO: Add maintainer information


πŸ“ License

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


πŸ’ͺ Thanks To All Contributors

Thanks a lot for spending your time helping TODO grow. Keep rocking πŸ₯‚

Contributors

Β© 2025 AOSSIE

About

Automatically Initializes Repos with Issues

Resources

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages