Merge pull request #6 from doITmagic/dev

doITmagic · web-flow · commit fa83010b8f09 · 2025-11-23T12:07:09.000+02:00
feat: Add Community Standards files
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run command '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 22.04, macOS Sonoma]
+ - RagCode Version: [e.g. v1.0.0]
+ - Ollama Version: [e.g. 0.1.32]
+ - Docker/Qdrant Status: [e.g. Running]
+ - Client/IDE: [e.g. Windsurf, Cursor, VS Code]
+
+**Logs**
+If applicable, add logs to help explain your problem.
+(Tip: You can enable debug logging in `config.yaml` or via environment variable `MCP_LOG_LEVEL=debug`)
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist:
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have formatted my code with `go fmt ./...`
+- [ ] I have run tests `go test ./...` and they pass
+- [ ] I have verified integration with Ollama/Qdrant (if applicable)
+- [ ] I have updated the documentation accordingly
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [razvan@doitmagic.com]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the involved people, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the involved people, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,87 @@
+# Contributing to RagCode MCP
+
+First off, thank you for considering contributing to RagCode MCP! It's people like you that make RagCode such a great tool.
+
+## 🛠️ Development Setup
+
+### Prerequisites
+
+- **Go 1.25+**: Required for building the project.
+- **Docker**: Required for running the Qdrant vector database.
+- **Ollama**: Required for LLM and embedding models.
+
+### Setting up the environment
+
+1. **Fork and clone the repository**
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/rag-code-mcp.git
+   cd rag-code-mcp
+   ```
+
+2. **Install dependencies**
+   ```bash
+   go mod download
+   ```
+
+3. **Start required services**
+   Ensure Docker and Ollama are running.
+   ```bash
+   # Start Qdrant
+   docker run -d -p 6333:6333 qdrant/qdrant
+   
+   # Pull models
+   ollama pull phi3:medium
+   ollama pull nomic-embed-text
+   ```
+
+4. **Run the server locally**
+   ```bash
+   go run ./cmd/rag-code-mcp
+   ```
+
+## 🧪 Testing
+
+We use the standard Go testing framework.
+
+```bash
+# Run all tests
+go test ./...
+
+# Run tests with race detection
+go test -race ./...
+```
+
+Please ensure all tests pass before submitting a Pull Request.
+
+## 📝 Coding Standards
+
+- **Formatting**: We use `gofmt`. Please run `go fmt ./...` before committing.
+- **Linting**: We recommend using `golangci-lint`.
+- **Commits**: We follow [Conventional Commits](https://www.conventionalcommits.org/).
+  - `feat: add new tool`
+  - `fix: resolve indexing bug`
+  - `docs: update README`
+
+## 🚀 Submitting a Pull Request
+
+1. Create a new branch: `git checkout -b feat/my-new-feature`
+2. Make your changes and commit them: `git commit -m 'feat: add some feature'`
+3. Push to the branch: `git push origin feat/my-new-feature`
+4. Submit a pull request!
+
+## 🐛 Reporting Bugs
+
+Bugs are tracked as GitHub issues. When filing an issue, please include:
+
+- Your OS and version
+- RagCode version
+- Ollama model being used
+- Steps to reproduce the issue
+
+## 💡 Feature Requests
+
+We welcome feature requests! Please use the Feature Request issue template and provide as much detail as possible about the use case.
+
+## 📄 License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,34 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of RagCode MCP seriously. If you discover a security vulnerability, please do NOT open a public issue.
+
+### How to Report
+
+Please report security vulnerabilities by emailing **razvan@doitmagic.com**.
+
+We will acknowledge your report within 48 hours and provide an estimated timeframe for a fix.
+
+### What to Include
+
+- Description of the vulnerability
+- Steps to reproduce
+- Potential impact
+- Any relevant logs or screenshots
+
+### Disclosure Policy
+
+We ask that you give us a reasonable amount of time to fix the issue before making it public. We will notify you when the fix is released.
+
+Thank you for helping keep RagCode secure!
