# Contributing to Obsidian MCP Setup
Thank you for your interest in contributing! This guide will help you get started.
## How to Contribute
### Reporting Issues
If you encounter problems:
1. Check the [troubleshooting guide](README.md#-troubleshooting)
2. Search existing issues
3. Create a new issue with:
- Clear description
- Steps to reproduce
- Your environment (OS, Amp version, Node version)
- Configuration (sanitized)
### Suggesting Enhancements
We welcome suggestions for:
- Additional examples
- Improved documentation
- Better configuration templates
- New workflows
Open an issue with the `enhancement` label.
### Submitting Pull Requests
1. **Fork the repository**
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes**
4. **Test thoroughly** on your platform
5. **Update documentation** if needed
6. **Commit**: `git commit -m 'Add amazing feature'`
7. **Push**: `git push origin feature/amazing-feature`
8. **Open a Pull Request**
### Documentation Guidelines
When contributing documentation:
- Use clear, concise language
- Include code examples
- Test all commands/configs
- Follow existing formatting
- Add table of contents if needed
### Code of Conduct
- Be respectful and inclusive
- Help others learn
- Accept constructive feedback
- Focus on what's best for the community
## Development Setup
1. Clone the repository
2. Create a test Obsidian vault
3. Set up the MCP configuration
4. Test with Amp
## Testing Checklist
Before submitting:
- [ ] Tested on your OS
- [ ] All commands work
- [ ] Documentation is accurate
- [ ] Examples are functional
- [ ] No sensitive data in commits
## Questions?
Feel free to open an issue for questions or join the discussion!
---
**Thank you for contributing!** 🎉