contributing.mdā¢2.22 kB
---
icon: material/account-group
---
# Contributing
Thank you for your interest in contributing to ToolFront! We :heart: contributions.
## Getting Started
1. **Fork the repository** on [GitHub](https://github.com/statespace-tech/toolfront)
2. **Clone your fork** and set up your development environment
3. **Create a branch** for your changes (`git checkout -b feature/your-feature-name`)
## Development Setup
```bash
# Clone the repository
git clone https://github.com/statespace-tech/toolfront.git
cd toolfront
# Install dependencies (using uv or pip)
uv sync
# or
pip install -e ".[dev]"
# Run tests
pytest
```
## Ways to Contribute
### Report Issues
Found a bug or have a feature request? Please [open an issue](https://github.com/statespace-tech/toolfront/issues) on GitHub. Include:
- A clear description of the problem or feature
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Your environment details (Python version, OS, etc.)
### Submit Pull Requests
1. **Write clear code** following existing patterns
2. **Add tests** for new features or bug fixes
3. **Update documentation** if needed
4. **Ensure tests pass** before submitting
5. **Write a clear PR description** explaining what and why
### Improve Documentation
Documentation improvements are always welcome! Help us make ToolFront easier to understand by:
- Fixing typos or clarifying confusing sections
- Adding examples or use cases
- Improving code comments
- Translating documentation
## Code Standards
- Follow Python style guidelines (PEP 8)
- Write meaningful commit messages
- Keep PRs focused and reasonably sized
- Add docstrings for new functions and classes
## Community
- **Discord**: Join our [community server](https://discord.gg/rRyM7zkZTf) for discussions
- **GitHub Issues**: Use issues for bug reports and feature requests
- **X**: Follow [@statespace_tech](https://x.com/statespace_tech) for updates
## Questions?
If you have questions about contributing, feel free to:
- Ask in our [Discord server](https://discord.gg/rRyM7zkZTf)
- Open a [GitHub Discussion](https://github.com/statespace-tech/toolfront/discussions)
- Email `esteban[at]statespace[dot]com`
We appreciate your contributions! š