Initial Release

2025-05-09 21:28:07 +07:00
commit 0c6cd18e6f
244 changed files with 50633 additions and 0 deletions
@@ -0,0 +1,119 @@
+
+# 🛠️ Contributing to CheckCle
+
+Thank you for your interest in contributing to **CheckCle** — the ultimate open-source platform for real-time full-stack monitoring. Whether you're here to report bugs, suggest features, improve documentation, or submit code, your contribution matters!
+
+We welcome all kinds of contributions, big or small. This guide will help you get started.
+
+---
+
+## 📌 Table of Contents
+- [Code of Conduct](#-code-of-conduct)
+- [Ways to Contribute](#-ways-to-contribute)
+- [Development Setup](#-development-setup)
+- [Pull Request Process](#-pull-request-process)
+- [Reporting Bugs & Issues](#-reporting-bugs--issues)
+- [Feature Requests](#-feature-requests)
+- [Community & Support](#-community--support)
+- [License](#-license)
+
+---
+
+## 📜 Code of Conduct
+
+We follow a [Code of Conduct](https://opensource.guide/code-of-conduct/) to foster an open and welcoming community. By participating, you agree to uphold these standards.
+
+---
+
+## 🤝 Ways to Contribute
+
+Here are some ways you can help improve CheckCle:
+
+- 🐞 **Report Bugs** – Found a glitch? Let us know by opening a [GitHub Issue](https://github.com/operacle/checkcle/issues).
+- 🌟 **Suggest Features** – Have an idea? Start a [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue.
+- 🛠 **Submit Pull Requests** – Improve the code, fix bugs, add features, or enhance the docs.
+- 📝 **Improve Documentation** – Even a typo fix helps!
+- 🌍 **Spread the Word** – Star ⭐ the repo, share it on socials, and invite others to contribute!
+
+---
+
+## 🧰 Development Setup
+
+Before contributing code, set up the project locally:
+
+### 1. Fork the Repository
+Click "Fork" on [GitHub](https://github.com/operacle/checkcle) to create your own copy.
+
+### 2. Clone Your Fork
+```bash
+git clone https://github.com/operacle/checkcle.git
+cd checkcle
+```
+
+### 3. Install Dependencies
+Follow the instructions in the README or project docs to install required packages and run the local development server.
+
+### 4. Start Local Development
+```bash
+#Web Application
+cd application/ 
+npm install && npm run dev
+
+#Server Backend
+cd server
+./pocketbase serve --dir pb_data
+```
+
+---
+
+## ✅ Pull Request Process
+
+1. Ensure your code follows the existing style and naming conventions.
+2. Write clear, concise commit messages.
+3. Push your branch and open a Pull Request (PR) on the `main` branch.
+4. Provide a meaningful PR description (what/why/how).
+5. Link related issues if applicable (e.g. `Closes #12`).
+6. Make sure all checks pass (e.g., linting, tests).
+
+We’ll review your PR, request changes if needed, and merge it once ready!
+
+---
+
+## 🐛 Reporting Bugs & Issues
+
+Please include as much information as possible:
+- A clear, descriptive title
+- Steps to reproduce
+- Expected vs actual behavior
+- Environment info (OS, browser, device, etc.)
+- Screenshots or logs if applicable
+
+Use the [Issue Tracker](https://github.com/operacle/checkcle/issues) to report.
+
+---
+
+## 💡 Feature Requests
+
+We’d love to hear your ideas! Open a [Discussion](https://github.com/operacle/checkcle/discussions) or Feature Request issue. Make sure it’s not already listed in the [Roadmap](https://github.com/operacle/checkcle#development-roadmap).
+
+---
+
+## 🌍 Community & Support
+
+Need help? Want to connect?
+
+- 💬 [Join our Discord](https://discord.gg/xs9gbubGwX)
+- 🗣 Start or join a [GitHub Discussion](https://github.com/operacle/checkcle/discussions)
+- 🐦 Follow us on [X (Twitter)](https://x.com/tl)
+
+---
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
+
+---
+
+## 🙏 Thank You
+
+We’re excited to build CheckCle together — a powerful monitoring platform **for the community, by the community**. Your support means the world! 💙