🚀 Help Wanted!
Join the Swiftfin Community of Contributors
Are you interested in contributing to Swiftfin? This guide outlines various ways you can help improve the application, regardless of your development experience.
💫 Why Contribute to Swiftfin?
Swiftfin belongs to all of us! As an open-source project, it thrives on community contributions. Every bug fix, translation, and feature you add makes the experience better for thousands of Jellyfin users across Apple devices. Whether you're a seasoned Swift developer or just getting started, your unique perspective can help us build something amazing together!
🤔 How Can I Help?
Below are some of the outstanding opportunities that you could help with to make Swiftfin better. While this list isn't comprehensive, it does contain some of the biggest pain-points that the core Swiftfin team haven't had the opportunity to address yet.
Some of these are ongoing efforts that continuously improve Swiftfin's quality and user experience. Others are one-off projects that will help take Swiftfin to the next level by adding important functionality or fixing persistent issues. As new items arise, we will keep this list updated to ensure there's a centralized place for contributors to get started.
🌲 Evergreen Opportunities
These are ongoing ways to contribute that are always valuable and help maintain Swiftfin's quality. These are items that don't necessarily have an issue or ticket, but are always in demand. We're constantly looking for community members to help with these essential tasks:
🐛 Helping Troubleshoot / Recreate Issues
Contributing to issue resolution is one of the most valuable ways to help. This involves:
- Reproducing reported issues in the GitHub issues tracker
- Providing detailed information about your environment when reporting bugs
- Helping identify duplicate issues so discussions can be consolidated
- Commenting on issues with additional information if you experience similar problems
🧪 Testing and Reporting Issues with TestFlight
Quality assurance is crucial for a stable app:
- Join our TestFlight program to access pre-release versions
- Test new features thoroughly across different devices and scenarios
- When reporting issues, include:
- Detailed steps to reproduce the problem
- Screenshots or screen recordings demonstrating the issue
- Information about your device, iOS version, and server configuration
- Any error messages that appear
🔍 Assistance with Finding Duplicate Issues
Help us maintain an organized issue tracker by:
- Identifying when new issues duplicate existing ones
- Suggesting issue consolidation to centralize communication
- Linking related issues to provide more context
- This helps our team combine duplicate issues to assist in better communication and tracking
🌐 Translation Assistance
Help make Swiftfin accessible to users worldwide:
- Visit our translation platform
- Contribute translations in languages you're fluent in
- Review existing translations for accuracy and natural phrasing
- Ensure technical terms are consistently translated throughout the application
📚 Documentation
Good documentation enhances user experience significantly:
- Create screenshot-based guides explaining different views and settings
- Document common issues and their solutions
- Develop step-by-step tutorials for new users
- A goal for Swiftfin is to be self-documenting where users can use it without documentation, but creating documentation on Github can assist in alleviating new issues or help users self-service their own issues
- If you're interested in helping us document Swiftfin but don't know where to start, feel free to reach out in the discussion below and we can help coordinate
📋 Documentation Maintenance
Helping maintain our existing resources:
- Review current documentation for accuracy
- Ensure all information is up to date with the latest app versions
- At this time, all documentation should be up to date but additional help reviewing and checking helps keep us up to date and ensure nothing is forgotten
🗺️ Roadmap
Please find a link to our project roadmap below:
Swiftfin - Roadmap
This is a great place to track open issues, see milestones, and find new items to work on!
🚀 Getting Started
- Start by reading our contribution guide
- Fork the repository and set up your development environment
- Choose a task that matches your skill level and interests
- Create or comment on the relevant GitHub issue to indicate you're working on it
- Create a draft pull requests to avoid duplicate work
- When ready, update your pull request to include clear explanations of changes and mark it as
Ready to Review
- Be responsive to code review feedback
The Jellyfin team appreciates all contributions, from documentation improvements to complex feature implementations. Your help makes Swiftfin better for everyone!
Comments or concerns? Questions about getting started? Please feel free to reach out in the discussion below and I can assist you there!
|