From a50a089dea919dc61a8b12678744a435f3f7f245 Mon Sep 17 00:00:00 2001 From: Einar Date: Tue, 12 May 2026 19:12:31 +0200 Subject: [PATCH] Add CONTRIBUTING.md with Claude prompt and update README --- CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 71 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..525b18e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing + +This file contains the prompt and setup info for adding new guides via Claude. + +## Prompt for new chat + +``` +I have a guides repo on my self-hosted Forgejo instance. Here's everything +you need to work with it directly. + +## Git setup + +Remote: git@vps-forgejo-01.warthog-rockhopper.ts.net:egeidal/guides.git +Local folder: ~/guides +SSH config for Forgejo is already in ~/.ssh/config — port 22, key ~/.ssh/id_rsa +Git identity: Einar / me@ege.cx + +## Workflow rules — follow these strictly, no exceptions + +1. Always show me the full content of any new guide before writing anything +2. Wait for explicit confirmation before writing or pushing anything +3. When adding a new guide, also update README.md to include a link and + one-line description — show me that too before writing +4. Commit each file separately with a clear message +5. Never run multiple destructive steps in a single command without confirmation + +## Repo structure + +Flat — all guides are .md files in the root. README.md links to all of them. + +Current guides: +- git.md — version control basics +- markdown.md — Markdown syntax reference +- rclone.md — file syncing, SFTP remotes, SSH key auth + +## Guide format + +Each guide follows this structure: +1. What is it — short intro, mental model if relevant +2. What it is mainly used for — bullet list +3. Installation — if applicable +4. Core concepts / configuration — whatever is relevant to the tool +5. Core commands with examples — real, practical examples not toy ones +6. Useful flags — table format +7. Notes — gotchas, opinions, things that bit me in practice + +Tone: direct, practical, no padding. Examples should be real where possible +(my actual hostnames, paths, and use cases are fine to use). + +## Tools available to you + +- Desktop Commander write_file — write to /tmp/ on my Mac +- Control your Mac osascript — run shell commands on my Mac +- SSH access to vps-hetzner-01.warthog-rockhopper.ts.net as egeidal +- Tailnet: warthog-rockhopper.ts.net + +## To add a new guide + +1. Write the guide content and show it to me +2. Wait for confirmation +3. Write it to /tmp/.md via Desktop Commander +4. Update README.md and show me the new entry +5. Wait for confirmation +6. cp /tmp/.md ~/guides/.md +7. cp /tmp/README.md ~/guides/README.md +8. git add, commit, push from ~/guides +``` diff --git a/README.md b/README.md index d152f64..e016fb8 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,7 @@ Personal reference docs for tools I use regularly. - [git](git.md) — Version control. Tracking changes, committing, pushing to Forgejo, undoing mistakes. - [markdown](markdown.md) — Lightweight markup language for formatting plain text. Headings, lists, code blocks, tables, and more. - [rclone](rclone.md) — File syncing and copying between local storage and remote destinations. SFTP, object storage, and 60+ backends. + +## Meta + +- [CONTRIBUTING](CONTRIBUTING.md) — Prompt and setup info for adding new guides via Claude.