Files
awesome-copilot/skills/repo-standardizer/templates/README.md
T
Guiyu Li 09e7be729f Add repo-standardizer skill: polish any GitHub repo surface (#2715)
* Add repo-standardizer skill: polish any GitHub repo surface

* fix(skill): remove non-string metadata and fix template README refs for vally lint

* docs(skill): drop markdown relative links from README language-switcher example

Vally valid-refs flagged ./README.md and ./README.zh.md as missing file
references; they are generated artifacts, not skill files. Keep the
example as plain text to satisfy the linter.

* fix(template): add missing language switcher to English README template

Align with README.zh.md template and SKILL.md switcher convention:
current language as plain text, other languages as relative links.

---------

Co-authored-by: programmingWTF <programmingWTF@users.noreply.github.com>
2026-08-21 14:01:37 +10:00

63 lines
1.2 KiB
Markdown

# PROJECT_NAME
< English | [简体中文](./README.zh.md) >
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
![GitHub release](https://img.shields.io/github/v/release/OWNER/REPO)
![GitHub issues](https://img.shields.io/github/issues/OWNER/REPO)
![GitHub pull requests](https://img.shields.io/github/issues-pr/OWNER/REPO)
![GitHub stars](https://img.shields.io/github/stars/OWNER/REPO)
> One-line description of what this project does.
## ✨ Features
- Feature one
- Feature two
- Feature three
## 🚀 Getting started
### Prerequisites
- Tool A
- Tool B
### Installation
```bash
git clone https://github.com/OWNER/REPO.git
cd REPO
# install steps
```
### Usage
```bash
# quick start command
```
## 📖 Documentation
| Topic | Where |
|---|---|
| API reference | `docs/api.md` |
| Architecture | `docs/architecture.md` |
| Contributing | [CONTRIBUTING.md](CONTRIBUTING.md) |
| Security | [SECURITY.md](SECURITY.md) |
## 🧪 Testing
```bash
# test command
```
## 🤝 Contributing
PRs welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
Report bugs via the [issue forms](https://github.com/OWNER/REPO/issues/new/choose).
## 📄 License
[MIT](LICENSE) © 2026 OWNER