prompts/README.md
sneak 3a5ac2d72f
All checks were successful
check / check (push) Successful in 7s
Fix typo and match second quickstart example to first
- Fix "do you work" → "do your work"
- Reformat new-repo quickstart to use same multi-line style
2026-02-22 16:47:12 +01:00

68 lines
2.0 KiB
Markdown

# prompts
prompts is an MIT-licensed collection of LLM prompts by
[@sneak](https://sneak.berlin), including development policy prompts and other
useful prompts for working with large language models.
## Quick Start
Bring an existing repo up to standards (run from within the repo):
```bash
export TD="$(mktemp -d)"
export INSTRUCTIONS="Read $TD/prompts/REPO_POLICIES.md and
$TD/prompts/EXISTING_REPO_CHECKLIST.md, then bring this repo up to those
standards. Be very careful to follow the policies yourself while
making these changes, ie: do your work on a feature branch, make each
change as a separate commit, make a formatting commit up front, et cetera."
git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$TD" && claude "$INSTRUCTIONS"
```
Start a new repo from scratch:
```bash
export TD="$(mktemp -d)"
export INSTRUCTIONS="Read $TD/prompts/REPO_POLICIES.md and
$TD/prompts/NEW_REPO_CHECKLIST.md, then set up this new repo according
to those standards. Be very careful to follow the policies yourself while
making these changes, ie: do your work on a feature branch, make each
change as a separate commit, et cetera."
git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$TD" && claude "$INSTRUCTIONS"
```
## Getting Started
```bash
git clone https://git.eeqj.de/sneak/prompts.git
cd prompts
```
Prompts are stored as Markdown files in `prompts/`. Copy or reference them as
needed in your projects.
## Rationale
LLM prompts, especially development policies, benefit from version control and a
single authoritative source. This repo provides a central place to maintain,
share, and evolve prompts across projects.
## Design
The repository is a flat collection of Markdown files. Each file contains one or
more related prompts or policy documents. There is no build step or runtime
component; the prompts are consumed by copying them into other projects or
referencing them directly.
## TODO
- Add more prompt templates for common development tasks
- Add CI to lint Markdown
## License
MIT. See [LICENSE](LICENSE).
## Author
[@sneak](https://sneak.berlin)