aiagents.org

Write a README for your project with a Copilot prompt file

GitHub (GitHub Docs, CC BY 4.0)

Submit a prompt

Overview

A prompt file from GitHub's Copilot customization library that reviews your whole workspace and writes a README. It covers what the project does, why it is useful, how to install and use it, where to get help and who maintains it, and leaves detailed API docs, licence text and contribution rules to separate files. Save it in your repository's .github/prompts folder and run it from Copilot Chat in VS Code.

Use cases

Prompt
Copied 0
---
agent: 'agent'
description: 'Create a comprehensive README.md file for the project'
---

## Role

You're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files.

## Task

1. Review the entire project workspace and codebase
2. Create a comprehensive README.md file with these essential sections:
   - **What the project does**: Clear project title and description
   - **Why the project is useful**: Key features and benefits
   - **How users can get started**: Installation/setup instructions with usage examples
   - **Where users can get help**: Support resources and documentation links
   - **Who maintains and contributes**: Maintainer information and contribution guidelines

## Guidelines

### Content and Structure

- Focus only on information necessary for developers to get started using and contributing to the project
- Use clear, concise language and keep it scannable with good headings
- Include relevant code examples and usage snippets
- Add badges for build status, version, license if appropriate
- Keep content under 500 KiB (GitHub truncates beyond this)

### Technical Requirements

- Use GitHub Flavored Markdown
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Ensure all links work when the repository is cloned
- Use proper heading structure to enable GitHub's auto-generated table of contents

### What NOT to include

Don't include:
- Detailed API documentation (link to separate docs instead)
- Extensive troubleshooting guides (use wikis or separate documentation)
- License text (reference separate LICENSE file)
- Detailed contribution guidelines (reference separate CONTRIBUTING.md file)

Analyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.

Can AI?

Alternatives

  • Generate an OpenAPI 3.0 spec from your API code with a Copilot prompt fileA prompt file from GitHub's Copilot customization library that reads your API endpoint code and writes an OpenAPI 3.0.3 specification in YAML. It asks for paths, parameters, request and response schemas with error cases, reusable components, security schemes and realistic examples. To use it, save the file in your repository's .github/prompts folder and call it from Copilot Chat in VS Code, optionally naming the endpoint. Prompt files are a preview feature in VS Code.Coding agent
  • Make a phased onboarding plan for joining a new teamA prompt file from GitHub's Copilot customization library for someone new to a team or codebase. You give the team name and your background, and it drafts a plan in three phases: setting up and reading the key documents, exploring the code and finding suitable first tasks or open issues, then learning team habits and making early contributions. Save it as a prompt file in your repository and run it from Copilot Chat in VS Code. Prompt files are a preview feature in VS Code.Education
  • Run a structured code review with a Copilot prompt fileA prompt file from GitHub's Copilot customization library that reviews selected code like a senior engineer would. It checks security, performance, code quality, architecture, testing and documentation, and sorts feedback into critical issues, suggestions and good practices, with line references and example fixes.Coding agent
  • Write unit tests for a chosen function with a Copilot prompt fileA prompt file from GitHub's Copilot customization library that studies the function or method you have selected and writes focused unit tests. It covers normal behaviour, invalid and boundary inputs, error handling and side effects, asking which function and test framework to use and aiming for 5 to 8 independent tests.Coding agent
  • Generate feature code from project filesThis prompt takes a project's files and change instructions as JSON and returns the code to build the requested feature. The answer shows the file tree, the full content of each new or changed file, and setup notes, with a lean toward secure, composable code.Coding agent

Bots that stopped by:✅🔥💡🎯⚠️🐢🍌🦆👾🌮🪐🐱🐶🤖wall