From 7750ac8d731ab2826a55756852627891ddc9581b Mon Sep 17 00:00:00 2001
From: Ayo Ayco <ayo@ayco.io>
Date: Sat, 1 Mar 2025 12:09:58 +0100
Subject: [PATCH] chore: add contribution section in readme

---
 CONTRIBUTING.md |  9 +++++++--
 README.md       | 10 ++++++++++
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e330aa5..84281d2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,6 +3,7 @@
 Hi, and thanks for your interest to contribute to **McFly**! 🎉
 
 This guide is the best place to start if you want to contribute to the project. You can do so by any of the following:
+
 1. [Report issues or request features](#report-issues-or-request-features)
 1. [Participate in discussions](#participate-in-discussions)
 1. [Contribute code](#contribute-code)
@@ -25,22 +26,26 @@ To get started, setup [git send-email](https://git-send-email.io).
 After setting up `git send-email` you can now follow the steps below to start hacking:
 
 1️⃣ Clone the repository to your local machine, then go into the project directory:
+
 ```bash
 $ git clone https://git.sr.ht/~ayoayco/mcfly
 $ cd mcfly
 ```
 
 2️⃣ Create a new branch for your changes:
+
 ```bash
 $ git checkout -b my-branch
 ```
 
 3️⃣ Make your changes, and then commit them with a descriptive message using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
+
 ```bash
 $ git commit -m "feat(core): implement server-side rendering"
 ```
 
 4️⃣ Use `git send-email` to send a patch:
+
 ```bash
 $ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
 ```
@@ -48,6 +53,7 @@ $ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
 ### Tips:
 
 💡 You can set the default "to" address for the project:
+
 ```bash
 $ git config sendemail.to "~ayoayco/mcfly-patches@lists.sr.ht"
 ```
@@ -58,7 +64,6 @@ $ git config sendemail.to "~ayoayco/mcfly-patches@lists.sr.ht"
 
 > As a summary, we use `git` and `email` to collaborate on McFly. You have to set up [git send-email](https://git-send-email.io) and send patches via email. :)
 
-
 ## Get in touch
 
-If something needs clarification, or even if you just want to chat about the project, don't hesitate to reach out to me via email [`ayo@ayco.io`](mailto:ayo@ayco.io). Thanks! :)
\ No newline at end of file
+If something needs clarification, or even if you just want to chat about the project, don't hesitate to reach out to me via email [`ayo@ayco.io`](mailto:ayo@ayco.io). Thanks! :)
diff --git a/README.md b/README.md
index 37e2c6f..ce88b7b 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,16 @@ It is primarily a runtime middleware for [Nitro](https://nitro.build). Every tim
 
 A plugin system allows for the core functionality to only "lean" on platform. Anything not yet a standard is implemented as a plugin which will be easily "swapped" away when the platform catches up.
 
+## Contribution
+
+There is [a guide for contributing via SourceHut](https://git.sr.ht/~ayoayco/mcfly/tree/main/item/CONTRIBUTING.md).
+
+But you can also contribute via official mirrors of the project repository in the following platforms:
+
+1. [McFly @ GitHub](https://github.com/ayoayco/mcfly)
+
+We will add more guides & mirrors for different platforms.
+
 ## Features
 
 ✅ Use vanilla custom elements (or sugar-coated web components)<br>