Pythagora-io/gpt-pilot

TechnicalWriter - Initialise Project

Open

#238 opened on Oct 19, 2023

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (2,685 forks)batch import
documentationenhancementgood first issueresume

Repository metrics

Stars
 (27,167 stars)
PR merge metrics
 (Avg merge 11h 50m) (1 merged PR in 30d)

Description

A new Tech Writer agent should create:

  • .editorconfig
  • .gitignore
  • .gpt-pilot/project.yml : modules (if multi module project, which we don't freaky support yet)
  • scripts folder: lint, test, run, deploy, get_dependencies (#189)
  • README.md
    • Project Summary
    • Usage
      • Requirements
      • Building
      • Running locally
      • Deployment
    • Directory Structure - with explanation to help humans and LLM navigate the project (#49)
    • Link - This project was created with the help of GPT Pilot

This would help GPT Pilot (and humans) to navigate an existing project (#146)

The TechWriter agent could even operate asynchronously to the development tasks, and may need to be called upon to update the documentation.

Contributor guide

Research direction
Implement a TechnicalWriter agent that generates the specified project files (.editorconfig, .gitignore, project.yml, scripts, README) with the described content.
Tech stack
python
Domain
developer experiencedocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70