Contributing to Predictive Maintenance MCP Server

Contributing to Predictive Maintenance MCP Server

Thank you for your interest in contributing! This project thrives on **diverse contributions** — not just code. Whether you're a maintenance engineer, a Python developer, a technical writer, or a student exploring open source for the first time, there's a meaningful way for you to help.

---

Table of Contents

• Choose Your Contribution Path
• Code of Conduct
• Getting Started (All Contributors)
• Path 1: Domain Expert (No Coding Required)
• Path 2: Software Developer
• Path 3: Technical Writer / Translator
• Path 4: Tester / QA
• Coding Standards
• Pull Request Process
• Adding New Analysis Tools
• Recognition
• Questions?

---

Choose Your Contribution Path

Not everyone contributes in the same way, and **all contributions are equally valued**. Find your path:

🔧 Path 1: Domain Expert *Maintenance engineer, reliability analyst, vibration specialist* **You don't need to write code.** Your industrial knowledge is the most valuable asset this project needs. Validate diagnostic accuracy against real-world experience Provide real vibration datasets (anonymized) Review whether fault detection results make engineering sense Suggest new diagnostic workflows from your daily practice ➡️ [Jump to Path 1 details](#path-1-domain-expert-no-coding-required)

💻 Path 2: Software Developer *Python developer, AI/ML engineer, full-stack dev* **The architecture is clean and extensible.** Adding a new MCP tool is as simple as writing a Python function with a decorator. Add new diagnostic tools Improve ML models Build Docker support Enhance the report system ➡️ [Jump to Path 2 details](#path-2-software-developer)

📖 Path 3: Technical Writer *Documentation specialist, translator, educator* **Clear documentation saves hours** for every future user. Help us explain complex concepts simply. Improve tutorials and examples Translate documentation Write case studies Create video walkthroughs ➡️ [Jump to Path 3 details](#path-3-technical-writer--translator)

🧪 Path 4: Tester / QA *Quality assurance, edge case hunter, validation specialist* **Break things on purpose.** Find the inputs that make the system fail — that's how we make it robust. Test with unusual data formats Validate results against ground truth Report edge cases and unexpected behaviors Cross-platform testing (Windows/macOS/Linux) ➡️ [Jump to Path 4 details](#path-4-tester--qa)