Pythagora-io/gpt-pilot

TechnicalWriter - Initialise Project

Open

#238 opened on Oct 19, 2023

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

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

Tech stack
python
Domain
documentationtooling
Issue type
documentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
gitbasic markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue asks to create standard project files: .editorconfig, .gitignore, README.md with details, and a scripts folder with lint, test, run, deploy, get dependencies. The assignee is already working on it, but the task is well defined. Examine the repository structure at https://github.com/Pythagora io/gpt pilot to understand existing conventions. Reference linked issues #189 and #146 for context. No PR is linked yet, so check if the assignee has made progress in a fork.