OpenAthleteOpenAthlete

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

  1. Fork the repository
  2. Clone your fork
  3. Set up development environment - See Development Setup
  4. Create a branch for your changes
  5. Make your changes
  6. Test thoroughly
  7. 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

  1. Update documentation if needed
  2. Ensure all tests pass
  3. Run type checking: pnpm tsc:check
  4. Write a clear PR description
  5. Link related issues
  6. Request review from maintainers

Code of Conduct

Please read our Code of Conduct before contributing.

Getting Help

Recognition

Contributors are recognized in:

  • Release notes
  • Contributors page
  • GitHub contributors list

Thank you for helping make OpenAthlete better! 🎉

On this page