Giter Club home page Giter Club logo

junior's Introduction

Docs: Junior Documentation

Junior - Your AI contributor which codes itself.

Video: Junior codes itself

"Video: Junior codes itself"

Description

Junior is an AI-first IDE designed from the ground up to leverage language models. Just like how Linus Torvalds oversees the Linux Kernel development without coding himself, this project allows developers to communicate with the AI and supervise the development process.

By providing specific task details in a prompt descriptor and highlighting the relevant parts of your project, you can delegate code implementation, documentation, testing, and more to your AI Junior.

Getting Started

Installation

To install, clone the repository and run npm install in the root directory. Additionally, you can install the "Junior" vscode extension from the vscode extension marketplace.

Usage

Web Interface

Run the application with npm start to start a local server, where you can generate a prompt and automatically copy it to paste into ChatGPT. The web interface is designed for use with ChatGPT Pro and doesn't require an API key. For more information about the web interface, please refer to docs/web.md.

The Prompt Descriptor

A prompt descriptor is a YAML file (prompt.yaml) outlining the details necessary for generating a task prompt for the AI model.

Each element in the descriptor serves a specific purpose:

  • task: Describes the task type and scope. For example, feature/implement, bug/fix, or refactor/. You can check out the prompt/task/feature/implement.md file as an example.
  • attention: Lists the files and directories most relevant to the task.
  • requirements: Describes the actual task in a human-readable format.
  • format: Determines how the output will be formatted.

Attention Mechanism

The attention mechanism guides the AI model by providing it with a working set. It helps overcome the limited working memory of large language models.

The working set is a subset of the entire project that's currently in focus. It includes both files and directories. For files, the content is directly provided to the AI. For directories, a brief list of files and subdirectories within them is presented.

Contributing and Support

Your contributions make a difference! At Junior, we value the collaboration of the community. Your role as a contributor is to monitor the development, provide detailed prompts, and thoroughly review the generated outcomes.

For support, please create an issue in the GitHub repository.

Note: For meaningful results, it's recommended to use the GPT-4 model or a more recent version.

junior's People

Contributors

tisztamo avatar darshandixit05 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.