From 744219c865f391dd1d522f3d3cd6e0d744461d6a Mon Sep 17 00:00:00 2001
From: Anirudh Oppiliappan <x@icyphox.sh>
Date: Wed, 21 May 2025 07:34:27 +0000
Subject: [PATCH] docs: reword contributing guide and link hacking.md

---
 readme.md | 11 ++++++-----
 docs/contributing.md | 21 ++++++++++++---------
 2 file(s) changed, 18 insertion(s)(+), 14 deletion(s)(-)

diff --git a/readme.md b/readme.md
--- a/readme.md
+++ b/readme.md
@@ -4,14 +4,15 @@
 [Tangled](https://tangled.sh)&mdash;a code collaboration platform built
 on the [AT Protocol](https://atproto.com).
 
-Read the introduction to Tangled [here](https://blog.tangled.sh/intro).
+Read the introduction to Tangled [here](https://blog.tangled.sh/intro). Join the
+[Discord](https://chat.tangled.sh) or IRC at [#tangled on
+libera.chat](https://web.libera.chat/#tangled).
 
 ## docs
 
-* [knot hosting
-guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/knot-hosting.md)
-* [contributing
-guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/contributing.md)&mdash;**read this before opening a PR!**
+* [knot hosting guide](/docs/knot-hosting.md)
+* [contributing guide](/docs/contributing.md) **please read before opening a PR!**
+* [hacking on tangled](/docs/hacking.md)
 
 ## security
 
diff --git a/docs/contributing.md b/docs/contributing.md
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -4,13 +4,13 @@
 
 We follow a commit style similar to the Go project. Please keep commits:
 
-* **atomic**: each commit should represent one logical change  
+* **atomic**: each commit should represent one logical change
 * **descriptive**: the commit message should clearly describe what the
 change does and why it's needed
 
 ### message format
 
-``` 
+```
 <service/top-level directory>: <affected package/directory>: <short summary of change>
 
 
@@ -26,12 +26,16 @@
 appview: state: fix token expiry check in middleware
 
 The previous check did not account for clock drift, leading to premature
-token invalidation. 
+token invalidation.
 ```
 
 ```
 knotserver: git/service: improve error checking in upload-pack
 ```
+
+The affected package/directory can be truncated down to just the relevant dir
+should it be far too long. For example `pages/templates/repo/fragments` can
+simply be `repo/fragments`.
 
 ### general notes
 
@@ -52,17 +56,16 @@
 Small fixes like typos, minor bugs, or trivial refactors can be
 submitted directly as PRs.
 
-For larger changes—especially those introducing new features,
-significant refactoring, or altering system behavior—please open a
-proposal first. This helps us evaluate the scope, design, and potential
-impact before implementation.
+For larger changes—especially those introducing new features, significant
+refactoring, or altering system behavior—please open a proposal first. This
+helps us evaluate the scope, design, and potential impact before implementation.
 
 ### proposal format
 
 Create a new issue titled:
 
-``` 
-proposal: <affected scope>: <summary of change> 
+```
+proposal: <affected scope>: <summary of change>
 ```
 
 In the description, explain:

--
tangled.sh