From c7e275d4ecc951e1156b1fa4f7fa40aea4c7e53a Mon Sep 17 00:00:00 2001
From: Aine <97398200+aine-etke@users.noreply.github.com>
Date: Sat, 31 Aug 2024 16:16:22 +0300
Subject: [PATCH] Create CONTRIBUTING.md

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..cf6f169
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+# Contributing to [etkecc/synapse-admin](https://github.com/etkecc/synapse-admin)
+
+While etke.cc fork is intended to accept more QoL changes and features, 
+it's good idea to open PR into the upstream repo: [Awesome-Technologies/Synapse-Admin](https://github.com/Awesome-Technologies/synapse-admin).
+
+1. Use the etkecc/synapse-admin **master** branch as your branch upstream: `git checkout master; git pull; git checkout -b my-new-feature`
+2. Once your changes are ready, please, open **2** PRs: one from your branch to `Awesome-Technologies/Synapse-Admin` **master**, and another one to `etkecc/synapse-admin` **main**
+3. Once PR is accepted in the `etkecc/synapse-admin`, update `README.md` file (either directly in the `main` branch, or via another PR) to add link to the merged PR in the [Fork differences](https://github.com/etkecc/synapse-admin#fork-differences) section
+
+4. **Why?**
+
+5. The upstream project may not want to accept all the changes, so to ensure they are not lost, we will gladly add them to the etke.cc fork.
+6. Unfortunately, it's challenging to keep changes separated, so to avoid messing upstream and fork changes (e.g., CI changes that should not be pushed to the upstream, as they intended for this fork specifically),
+7. there are 2 branches:
+8.
+9. * `master` - read-only copy of upstream's master branch to easily sync changes, and use it as base for new PRs
+   * `main` - fork-own branch with all changes