Contributing
Learn how to contribute to OpenAthlete
Thank you for your interest in contributing to OpenAthlete! This guide will help you get started.
Ways to Contribute
- 🐛 Report bugs - Help us find and fix issues
- 💡 Suggest features - Share your ideas
- 📝 Improve documentation - Make docs better
- 🔧 Write code - Fix bugs or add features
- 🎨 Design - Improve UI/UX
- 🌍 Translate - Add new languages
- 📢 Spread the word - Share OpenAthlete
Getting Started
- Fork the repository
- Clone your fork
- Set up development environment - See Development Setup
- Create a branch for your changes
- Make your changes
- Test thoroughly
- Submit a pull request
Development Setup
See our Development Setup Guide for detailed instructions.
Code Standards
- TypeScript - All code must be typed
- Linting - Follow ESLint rules
- Formatting - Use Prettier
- Testing - Write tests for new features
- Documentation - Document your code
Pull Request Process
- Update documentation if needed
- Ensure all tests pass
- Run type checking:
pnpm tsc:check - Write a clear PR description
- Link related issues
- Request review from maintainers
Code of Conduct
Please read our Code of Conduct before contributing.
Getting Help
- Discord - Join our community and ask questions
- GitHub Issues - Report bugs
Recognition
Contributors are recognized in:
- Release notes
- Contributors page
- GitHub contributors list
Thank you for helping make OpenAthlete better! 🎉