CONTRIBUTING.md•2.06 kB
# Contributing to Apple Doc MCP
Thank you for considering contributing to Apple Doc MCP! 🍎
## Quick Start
1. **Fork the repository** on GitHub
2. **Clone your fork** locally:
```bash
git clone https://github.com/yourusername/apple-doc-mcp.git
cd apple-doc-mcp
```
3. **Install dependencies**:
```bash
npm install
```
4. **Build the project**:
```bash
npm run build
```
## Making Changes
### Development Workflow
1. Create a new branch for your feature/fix:
```bash
git checkout -b feature/your-feature-name
```
2. Make your changes
3. Test your changes:
```bash
npm run build
npm run start # Test that server starts
```
4. Commit your changes:
```bash
git commit -m "Add: brief description of your changes"
```
5. Push to your fork:
```bash
git push origin feature/your-feature-name
```
6. **Create a Pull Request** on GitHub
### Code Guidelines
- **TypeScript**: Use strict TypeScript types
- **Error Handling**: Always handle errors gracefully
- **Comments**: Add clear comments for complex logic
- **Testing**: Test your changes with real Apple documentation APIs
### What We're Looking For
- 🐛 **Bug fixes** - Especially edge cases with Apple's API
- ✨ **New features** - Additional search capabilities, filtering options
- 📚 **Documentation** - Improvements to README, examples, setup guides
- 🚀 **Performance** - Caching improvements, faster search algorithms
- 🔧 **Compatibility** - Support for more AI assistants and MCP clients
## Reporting Issues
Before creating an issue:
1. **Search existing issues** to avoid duplicates
2. **Test with latest version** to ensure it's not already fixed
3. **Use the issue template** for better context
## Questions?
- Open an issue with the "Question" label
- Check existing issues and discussions
- Review the [README.md](README.md) and [SETUP.md](SETUP.md)
## License
By contributing, you agree that your contributions will be licensed under the same license as this project.
---
**Happy coding!** 🚀