sneak/prompts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve quickstart commands with two-pass workflow
All checks were successful
check / check (push) Successful in 4s
Details

Browse Source 
Split quickstart into separate repo-policy and code-style passes, clone
prompts repo once instead of per-command, and make each prompt
self-contained so agents don't need memory of prior runs.
This commit is contained in:
Jeffrey Paul 2026-02-23 00:33:15 +07:00
parent cb5d630158
commit 05fe766c62
1 changed files with 75 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -6,28 +6,90 @@ useful prompts for working with large language models.
## Quick Start ## Quick Start
Bring an existing repo up to standards (run from within the repo): ### Existing Repo
Run from within the repo you want to bring up to standards. Clone the prompts
repo once, then run both commands in order.
```bash ```bash
export TD="$(mktemp -d)" export TD="$(mktemp -d)"
export INSTRUCTIONS="Read $TD/prompts/REPO_POLICIES.md and git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$TD"
$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: **Repository structure and policies:**
```bash
claude "Read $TD/prompts/REPO_POLICIES.md and
$TD/prompts/EXISTING_REPO_CHECKLIST.md, then bring this repo up to those
standards. Your scope is repo scaffolding and policy compliance:
Makefile, Dockerfile, .dockerignore, .gitignore, .editorconfig, CI
workflow, README sections, LICENSE, REPO_POLICIES.md, and any
language-specific config files (.golangci.yml, .prettierrc, etc.).
You must also run the formatter (make fmt) and fix any linter errors
(make lint) so that make check passes — this will touch source code,
but do not restructure, refactor, or rewrite any application logic.
Follow the policies yourself: work on a feature branch, never git add -A,
and make each logical change a separate commit (e.g. one commit for
formatting, one for linter fixes, one for README updates, one for each
new repo file added, etc.)."
```
**Code style and conventions:**
```bash
claude "Read $TD/prompts/CODE_STYLEGUIDE.md and whichever
language-specific styleguides in $TD/prompts/ apply to this repo
(CODE_STYLEGUIDE_GO.md, CODE_STYLEGUIDE_JS.md, CODE_STYLEGUIDE_PYTHON.md,
GO_HTTP_SERVER_CONVENTIONS.md). Then review the application code in this
repo and bring it into compliance with those coding standards. Your scope
is application code structure and style: naming, patterns, error
handling, project layout, and conventions described in the styleguides.
Do not modify repo scaffolding (Makefile, Dockerfile, CI workflow,
.gitignore, .editorconfig, etc.) — only application code. Work on a
feature branch, never git add -A, and make each logical change a
separate commit."
```
### New Repo
Run from inside the directory where you want to create a new repo. Clone the
prompts repo once, then run both commands in order.
```bash ```bash
export TD="$(mktemp -d)" export TD="$(mktemp -d)"
export INSTRUCTIONS="Read $TD/prompts/REPO_POLICIES.md and git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$TD"
```
**Repository scaffolding:**
```bash
claude "Read $TD/prompts/REPO_POLICIES.md and
$TD/prompts/NEW_REPO_CHECKLIST.md, then set up this new repo according $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 to those standards. Your scope is repo structure and required files:
making these changes, ie: do your work on a feature branch, make each README.md, LICENSE, REPO_POLICIES.md, Makefile, Dockerfile, .dockerignore,
change as a separate commit, et cetera." .gitignore, .editorconfig, CI workflow, and language-specific config.
git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$TD" && claude "$INSTRUCTIONS" Run the formatter (make fmt) and fix any linter errors (make lint) so
that make check passes — this will touch source code, but do not
restructure, refactor, or rewrite any application logic. Follow the
policies yourself: work on a feature branch, never git add -A, and make
each logical change a separate commit (e.g. one commit for formatting,
one for linter fixes, one for README, one for each new repo file, etc.)."
```
**Code style and conventions:**
```bash
claude "Read $TD/prompts/CODE_STYLEGUIDE.md and whichever
language-specific styleguides in $TD/prompts/ apply to this repo
(CODE_STYLEGUIDE_GO.md, CODE_STYLEGUIDE_JS.md, CODE_STYLEGUIDE_PYTHON.md,
GO_HTTP_SERVER_CONVENTIONS.md). Then review the application code in this
repo and bring it into compliance with those coding standards. Your scope
is application code structure and style: naming, patterns, error
handling, project layout, and conventions described in the styleguides.
Do not modify repo scaffolding (Makefile, Dockerfile, CI workflow,
.gitignore, .editorconfig, etc.) — only application code. Work on a
feature branch, never git add -A, and make each logical change a
separate commit."
``` ```
## Getting Started ## Getting Started