prompts/README.md
sneak e97b48eea4
All checks were successful
check / check (push) Successful in 9s
Fix review issues: front matter, headings, consistency, typos
- Move title and last_modified to YAML front matter (all policy docs)
- Make all document sections H1, subsections H2
- Update version rule to reference front matter format
- Fix "our" → "your" typo in Go styleguide
- Fix Python styleguide numbering (2. → 1.)
- Fix README: "flat collection" → accurate description, remove stale TODO
- Remove Makefile items from code styleguides (repo stuff, not code),
  add note linking to Repository Policies
- Change zerolog → slog in Go styleguide
- Fix JS styleguide npm reference: both work, but use make targets
- Drop .json from healthcheck path, add JSON content-type requirement
- Add Author/License to Go HTTP Server Conventions
- Convert hyperlinks to backtick URLs in checklists for consistency
- Add version/front matter to both checklists
2026-02-22 17:15:06 +01:00

67 lines
2.1 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 collection of Markdown files organized in the `prompts/`
subdirectory. 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
## License
MIT. See [LICENSE](LICENSE).
## Author
[@sneak](https://sneak.berlin)