From 4912b5d6ebea0f5b4646b0ff30e4c6088f4df6b4 Mon Sep 17 00:00:00 2001
From: Shinei Nouzen <157171073+Shineii86@users.noreply.github.com>
Date: Thu, 2 Jul 2026 10:13:33 +0530
Subject: [PATCH] docs: update CONTRIBUTING.md with bypass solutions guide

- Added Contributing Bypass Solutions section (priority)
- Added free/open source tool table
- Added step-by-step guide for contributors
- Added code style examples (headers, section markers, feature markers)
---
 CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4e943cf..4e1cb4c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -50,6 +50,37 @@ MiruroAPI/
 - Follow existing patterns in the codebase
 - Keep helpers focused on one task
 
+### File Headers
+
+```js
+/*
+ * ======= • ======= • ======= • ======= • =======• =======
+ * MiruroAPI — filename.js
+ * Repository: https://github.com/Shineii86/MiruroAPI
+ *
+ * @description
+ *   What this module does.
+ *
+ * @author  Shinei Nouzen
+ * @license MIT
+ * ======= • ======= • ======= • ======= • =======• =======
+ */
+```
+
+### Section Markers
+
+```js
+// ══════════════════════════════════════════════════════════════
+// SECTION NAME
+// ══════════════════════════════════════════════════════════════
+```
+
+### Feature Markers
+
+```js
+// ---- FEATURE: Name ----
+```
+
 ## Commit Messages
 
 Use [Conventional Commits](https://www.conventionalcommits.org/):
@@ -75,6 +106,32 @@ Use [Conventional Commits](https://www.conventionalcommits.org/):
 - Include expected vs actual behavior
 - Include your Node.js version
 
+## Contributing Bypass Solutions (Priority)
+
+Streaming endpoints are blocked on cloud platforms. This is the most impactful contribution you can make.
+
+### What to Build
+
+Add a new fallback method in `src/helpers/pipe.js`. The file already has 3 methods (direct, ScraperAPI, FlareSolverr) — add yours as a 4th.
+
+### Free/Open Source Options
+
+| Tool | Language | Install |
+|------|----------|---------|
+| [nodriver](https://github.com/ultrafunkamsterdam/nodriver) | Python | `pip install nodriver` |
+| [Camoufox](https://github.com/nicandris/camoufox) | Python | `pip install camoufox` |
+| [curl_cffi](https://github.com/nicandris/curl_cffi) | Python | `pip install curl_cffi` |
+| [patchright](https://github.com/nicandris/patchright) | Python | `pip install patchright` |
+| [Scrape.do](https://scrape.do) | HTTP API | 1K free credits/mo |
+
+### Steps
+
+1. Fork and clone
+2. Add your method in `src/helpers/pipe.js`
+3. Add your API key/URL to `.env.example`
+4. Test: `curl http://localhost:3000/api/episodes/20`
+5. Submit PR
+
 ## License
 
 By contributing, you agree that your contributions will be licensed under the MIT License.