Initialize open-source community files (README, Contributing, Code of Conduct, and License)

shadil-rayyan · shadil-rayyan · commit 7d845fc0202a · 2026-01-18T01:51:40.000+05:30
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,47 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# Contributing to CodeCampus User Guide
+
+First off, thank you for considering contributing to the CodeCampus User Guide! It's people like you that make CodeCampus a great resource for students worldwide.
+
+## 📜 Our Vision
+
+We aim to provide the **best possible documentation** for beginner software engineers. We don't just want to list commands; we want to teach the **"Why"** and the **"How"** of professional development.
+
+---
+
+## 🛠️ How Can I Contribute?
+
+### 1. Reporting Bugs
+- Use the [GitHub Issue Tracker](https://github.com/CodeCompasss/code_campus_userguide/issues).
+- Describe the bug and, if possible, suggest a fix.
+
+### 2. Suggesting Enhancements
+- If you think a tool or workflow is missing, open an issue to discuss it.
+
+### 3. Adding or Improving Documentation
+This is the most impactful way to contribute! However, we have **strict quality standards**. All new tool documentation **MUST** follow the **[Antigravity.md Specification](Antigravity.md)**.
+
+#### Every tool description must include:
+1. **What is it?**: Conceptual, beginner-friendly explanation.
+2. **Installation**: Proper tabs for Ubuntu, Arch, Fedora, and openSUSE.
+3. **Why this tool matters (In Depth)**: The most important part—explain the "Why."
+4. **How students will actually use it**: Practical, concrete examples.
+5. **Professional Insight**: Senior-level tips and pitfalls to avoid.
+
+---
+
+## 🚀 Style Guide
+
+- **Professional Tone**: Avoid slang and emojis in the documentation body.
+- **Direct Language**: Be concise and avoid filler words.
+- **Markdown Headers**: Use only `#`, `##`, and `###` appropriately.
+- **No Marketing**: We are here to teach, not to sell.
+
+---
+
+## 📬 Pull Request Process
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code or documentation that should be tested, add tests or verify with `mkdocs serve`.
+3. Ensure your documentation adheres to the `Antigravity.md` spec.
+4. Open a Pull Request with a clear description of your changes.
+
+---
+
+By contributing, you agree that your contributions will be licensed under the project's MIT License.
+
+Happy coding! 🚀
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CodeCompass Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,77 @@
+# 🚀 CodeCampus OS — Official User Guide
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/CodeCompasss/code_campus_userguide/deploy.yml?branch=main)](https://github.com/CodeCompasss/code_campus_userguide/actions)
+[![Stars](https://img.shields.io/github/stars/CodeCompasss/code_campus_userguide?style=social)](https://github.com/CodeCompasss/code_campus_userguide/stargazers)
+
+> **Bridge the gap between academic theory and real-world software engineering.**
+
+CodeCampus OS is a custom Linux distribution designed specifically for Computer Science students and beginner developers. This repository contains the **Official User Guide**, a comprehensive, student-focused resource that documents the professional tools, workflows, and environments pre-configured in CodeCampus OS.
+
+---
+
+## 🌟 Why This Repo?
+
+Setting up a development environment often takes months for students to get right. CodeCampus OS removes that barrier, and this guide teaches you **how to master the tools like a Pro**.
+
+- 🎯 **Student-Focused**: Every explanation is written for beginners but never "dumbed down."
+- 🧠 **Professional Insight**: Learn the "Top 1%" tricks used by senior engineers.
+- 🛠️ **Actionable Workflows**: Concrete examples for everything from Git and Docker to Neovim and SQL.
+- 🐧 **Linux Agnostic**: While optimized for CodeCampus OS, our installation guides cover **Ubuntu, Arch, Fedora, and openSUSE**.
+
+---
+
+## 🗺️ Roadmap & Sections
+
+- **[Getting Started](https://codecompasss.github.io/code_campus_userguide/getting-started/index/)**: Philosophy, Hotkeys, and Tiling window management.
+- **[Terminal Mastery](https://codecompasss.github.io/code_campus_userguide/Terminal/index/)**: Deep dives into Zsh, CLI utilities (`fd`, `ripgrep`, `fzf`), and terminal UIs.
+- **[Development Stack](https://codecompasss.github.io/code_campus_userguide/Development/editors/vscode/)**: Mastering VS Code, Neovim, and Spyder with professional configuration.
+- **[System Utilities](https://codecompasss.github.io/code_campus_userguide/system-tools/extenstion/)**: Extension management, power efficiency, and remote access.
+
+---
+
+## 🛠️ Local Development
+
+This guide is built using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
+
+### Prerequisites
+- Python 3.x
+- `pip`
+
+### Setup
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/CodeCompasss/code_campus_userguide.git
+   cd code_campus_userguide
+   ```
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. Run the live preview:
+   ```bash
+   mkdocs serve
+   ```
+   Open `http://127.0.0.1:8000` in your browser.
+
+---
+
+##🤝 Contributing
+
+We love contributions! Whether it's fixing a typo, adding a new tool guide, or improving an explanation, please check out our **[Contributing Guide](CONTRIBUTING.md)**.
+
+---
+
+## ⭐ Support Us
+
+If you find this guide helpful, please **give us a star on GitHub!** It helps more students find this resource and stay motivated in their coding journey.
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+---
+
+Built with ❤️ by the **CodeCompass Team**.
