CONTRIBUTING
Enhance the Codebase
As a developer looking to amplify Raspirus's functionality, your contributions are invaluable. Please adhere to the following guidelines:
- Check Existing Issues: Before diving in, peruse existing issues to avoid creating duplicates. If none exist, feel free to open a new one.
-
Documentation is Key: Always ensure your code is well-documented. Remember to adapt tests to maintain code integrity.
Enrich the Documentation
Raspirus's documentation is crafted using Markdown and powered by MkDocs and Python. To contribute to the documentation:
- Follow the Guide: To begin, set up the documentation on your local machine by following the guide.
- Material Theme: Our documentation utilizes the Material Theme, which extends Markdown functionality. Discover more about it here.
Drive Translations
Our documentation is multilingual thanks to Crowdin, an intuitive external service. GUI translations are handled via JSON files. Refer to the guide for comprehensive insights.
Infuse Artwork and Media
The repository for artwork (logos, banners, etc.) and media (powerpoints, articles, graphs, etc.) is hosted separately at this repository. Feel free to contribute and bolster our visual presence. Note that the current logo and banner were AI-generated due to the lack of artistic expertise.
Provide Feedback
Beyond the above contributions, there are other impactful ways to get involved:
- Join Discord: Engage with our community on the Discord server to share valuable feedback and ideas.
- Consider Donating: If you find value in Raspirus, consider donating to support ongoing development.
- Spread the Word: A simple yet effective way to contribute is by downloading Raspirus and introducing it to friends.
Thank you for your dedication to Raspirus's growth and improvement. Your involvement is a cornerstone of our success.