Pythagora-io/gpt-pilot

TechnicalWriter - Initialise Project

Open

#238 创建于 2023年10月19日

在 GitHub 查看
 (1 评论) (0 反应) (1 负责人)Python (27,167 star) (2,685 fork)batch import
documentationenhancementgood first issueresume

描述

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.

贡献者指南

技术栈
python
领域
documentationtooling
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
gitbasic markdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.