home/productivity/prompt-create-github-readme

Prompt Create Github Readme

GPTClaudeDeepSeek··▲ 120 copies·updated 2026-07-14

prompt-create-github-readme.prompt

# Rule: Generating a GitHub Project README

## Goal

To guide an AI assistant in creating a concise Project README or description for a GitHub Project (fields-based). The README should explain how the project is used to manage work.

## Output

- **Format:** Markdown
- **Destination:** GitHub Project description field or linked Markdown document
- **Length:** Under ~1 page

## Context

The project follows these principles:

- GitHub Issues are the unit of work
- Status is tracked ONLY in the Project
- Markdown files (PRDs, ADRs) describe intent, not execution
- PRs close Issues
- CodeRabbit is used for automated review

## README Structure

Generate a Markdown document with the following sections:

when to use it

Community prompt sourced from the open-source GitHub repo schieble/amp-operating-protocol (MIT). A "Prompt Create Github Readme" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.