Skip to main content
Version: Next (2027.08.0)

Contributing

Thank you for your interest in contributing! Here's how you can help:

Report issues​

By far the easiest way to help make Karter better is to use it and report issues and bugs. Found a bug? Open an issue on GitHub.

Translations​

Support the project by localizing on Weblate. For more information, see the Translations section.

Development​

If you are a programmer or developer, take a look at Karter's technology stack (Architecture) and consider fixing bugs or building new features. Code contributions are welcome! Please follow the guidelines below to ensure a smooth contribution process.

Getting Started​

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add your feature')
  5. Push to the branch (git push origin feature/your-feature)
  6. Open a Pull Request

Guidelines​

  • Follow the existing code style
  • Write clear commit messages
  • Add tests for new functionality
  • Update documentation as needed
  • Never commit secrets or keys, and keep commits focused on a single change

Questions?​

Feel free to open an issue or contact the maintainers.