2

Contributing

Pavel Baksy edited this page 2026-01-13 17:42:28 +01:00

Table of Contents

• Contributing
• Reporting Issues
• Code Contributions
• Setup Development Environment
• Contribution Process
• Code Guidelines
• UI/UX Guidelines
• Documentation
• Translations
• Questions

Contributing

Contributions to Roster are welcome! Here's how you can help.

Reporting Issues

Report bugs or request features at: https://git.bugsy.cz/beval/roster/issues

Include:

• Description of the issue or feature request
• Steps to reproduce (for bugs)
• Expected vs actual behavior
• Roster version and installation method (native/Flatpak)

Code Contributions

Setup Development Environment

See Development for complete setup instructions.

Contribution Process

1. Fork the repository
2. Create a feature branch (git checkout -b feature-name)
3. Make your changes
4. Test your changes thoroughly
5. Commit with clear messages
6. Push to your fork
7. Open a pull request

Code Guidelines

• Follow existing code style and patterns
• Use Python type hints where appropriate
• Keep functions focused and well-named
• Add comments for complex logic
• Test your changes with both native and Flatpak builds

UI/UX Guidelines

• Follow GNOME Human Interface Guidelines
• Use libadwaita widgets and patterns
• Maintain consistency with existing UI
• Test with both light and dark themes

Documentation

Help improve documentation by:

• Fixing typos or unclear explanations
• Adding examples
• Updating outdated information

Translations

Help make Roster available in your language! See Translation for a simple guide on how to:

• Download the translation template
• Translate using Poedit or another editor
• Submit your translation via pull request

No programming or building required - just translate and submit!

Questions

For questions about contributing, open an issue on the bug tracker.