Welcome to the Batocera Unofficial Addons project! We appreciate your interest in contributing. Whether you're fixing a bug, adding a new feature, or improving documentation, please follow these guidelines to ensure smooth collaboration.
There are multiple ways to contribute to this project:
- Reporting issues and suggesting improvements
- Submitting bug fixes and patches
- Adding new features and enhancements
- Improving documentation
- Testing and providing feedback
Before contributing, please read the following guidelines.
If you encounter a bug or issue, please check existing issues before submitting a new one.
When reporting an issue:
- Provide a clear and descriptive title.
- Include steps to reproduce the issue.
- Mention your Batocera version and hardware details.
- Attach logs or screenshots if applicable.
Issues should be submitted in the GitHub Issues section.
¶ 1️⃣ Fork and Clone the Repository
-
Fork the repository on GitHub.
-
Clone your fork:
git clone https://github.com/batocera-unofficial-addons/batocera-unofficial-addons.git
cd batocera-unofficial-addons
-
Create a new branch for your changes:
git checkout -b feature-or-bugfix-name
¶ 2️⃣ Follow Coding Standards
- Shell Scripts: Use
shellcheck to lint your scripts.
- Python: Follow PEP 8 guidelines.
- JSON/XML/YAML: Validate before submitting.
- Keep commits small and meaningful.
- Ensure compatibility with multiple Batocera versions.
- Run the script or addon on Batocera to ensure it works.
- Use logs and debug messages for troubleshooting.
- If adding a new feature, write clear documentation.
¶ 4️⃣ Commit and Push
- Commit with a meaningful message:
git commit -m "Fix: Corrected install script for XYZ addon"
- Push changes to your fork:
git push origin feature-or-bugfix-name
- Go to the original repository and click New Pull Request.
- Select your branch and describe your changes.
- Follow the PR template and provide necessary details.
- Wait for code review and feedback.
- Keep PRs small and focused: Avoid combining multiple features or fixes in one pull request.
- Write meaningful commit messages: This helps maintainers understand changes quickly.
- Use clear variable names in scripts.
- Comment your code: Explain complex logic for better maintainability.
- Stay updated: Pull the latest changes before submitting new work.
¶ 📜 Licensing and Copyright
- By contributing, you agree to license your work under the same license as the project.
- Do not submit copyrighted content.
- If using third-party code, ensure proper attribution.
If you're unsure about something, feel free to:
Happy coding! 🚀