Grafana UI MCP Server

# Contributing to ShadCN-UI-MCP-Unofficial Thank you for considering contributing to **ShadCN-UI-MCP-Unofficial**! This project aims to provide a context-rich server for understanding the structure, usage, and installation of ShadCN UI components, and your contributions are critical to its success. ## How to Contribute ### 1. Reporting Issues If you find bugs, have feature requests, or want to share ideas: - **Search existing issues** to avoid duplication. - If no similar issue exists, [open a new issue](https://github.com/Jpisnice/shadcn-ui-mcp-unofficial/issues/new) with detailed information: - Steps to reproduce (if a bug) - Expected vs actual behavior - Screenshots, if applicable ### 2. Suggesting Features We welcome suggestions! Please include: - A clear description of the feature. - Why it would be useful. - Possible implementation details. ### 3. Submitting Code Contributions To contribute code: 1. **Fork the repository**: [How to fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo). 2. **Clone the repository**: ```bash git clone https://github.com/Jpisnice/shadcn-ui-mcp-unofficial.git ``` 3. **Create a feature branch**: ```bash git checkout -b feature/your-feature-name ``` 4. **Make your changes**: - Ensure your code adheres to the repository's coding style. - Add or update tests, if applicable. 5. **Run tests locally**: - Install dependencies: ```bash npm install ``` - Run tests: ```bash npm test ``` 6. **Commit your changes**: ```bash git commit -m "Add: Your concise commit message" ``` 7. **Push your branch**: ```bash git push origin feature/your-feature-name ``` 8. **Open a pull request (PR)**: - Go to your forked repository and click **New Pull Request**. - Provide a clear title and description for your PR. ### 4. Improving Documentation Documentation updates are as valuable as code contributions. If you find typos, unclear explanations, or missing details, feel free to: - Submit an issue. - Propose changes via pull requests. ## Code of Conduct We expect all contributors to adhere to our [Code of Conduct](https://github.com/Jpisnice/shadcn-ui-mcp-unofficial/blob/master/CODE_OF_CONDUCT.md). Be respectful, inclusive, and professional. ## Development Guidelines ### Project Setup This project heavily uses **TypeScript**. To get started: 1. Install dependencies: ```bash npm install ``` 2. Start the server locally: ```bash npm run dev ``` ### Coding Standards - Use **Prettier** and **ESLint** for consistent formatting. - Follow the established folder structure and naming conventions. ### Commit Messages Commit messages should follow the convention: ``` <type>: <short description> ``` Examples: - `Fix: Correct button alignment for mobile view` - `Add: Support for new ShadCN component` ### Pull Request Reviews All PRs will undergo review to maintain quality. The guidelines include: - Clear and concise code. - Proper error handling. - Compatibility with existing features. ## Need Help? If you have any questions or need further assistance, feel free to: - Ask in [Discussions](https://github.com/Jpisnice/shadcn-ui-mcp-unofficial/discussions). - Mention specific maintainers in issues or PRs. --- Thank you for your contribution! Together, we can make this project better. 🚀