From aa56aba1a5c3a8b3d954bcba2998f8b76a1d0b83 Mon Sep 17 00:00:00 2001
From: Thomas <3169-thomas@users.noreply.code.briarproject.org>
Date: Mon, 11 Jul 2022 11:40:01 +0000
Subject: [PATCH] Create CONTRIBUTING.md (describe folder names)

---
 CONTRIBUTING.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..1925761f0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+Folder-Description:
+===================
+* `briar-*`: Specifically for the Briar app (Phone/Desktop/Headless)
+* `bramble-*`: The protocol stack - not necessarily Briar-dependent
+
+---
+
+* `*-api`: public stuff that can be referenced from other packages and modules - mostly interfaces + a few utility classes
+* `*-core`: implementations of api that are portable across Android/Desktop/Headless
+* `*-java`: implementations of api that are specific to Desktop & Headless