Skip to main content

explain what’s in the repo

ID
f436660
date
2023-06-25 07:56:42+00:00
author
Alex Chan <alex@alexwlchan.net>
parent
c79d80b
message
explain what's in the repo
changed files
1 file, 7 additions

Changed files

README.md (2538) → README.md (2876)

diff --git a/README.md b/README.md
index 961614a..0f87c44 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,13 @@ To make it a bit easier to find, I've grouped them into a couple of top-level fo
 
 I add all the subfolders to my PATH so I don't need to remember how they're organised, but it might make it easier to find stuff!
 
+## What goes in this repo
+
+The script in this repo are pretty short – typically 50 lines or less (including documentation).
+They're mostly stuff that I can write all in one go.
+
+If a script gets sufficiently large and complicated that it might benefit from its own documentation or change history, it "graduates" into a separate repo.
+
 ## Contributors
 
 My scripts include code written by other people, and in those cases I've [attributed the commit that added the code/script to multiple authors][trailer].