How to Contribute
Thank you for your interest in contributing to these open source repositories on GitHub. Contributions help improve the services for everyone. Here's how you can get involved:
Hold Discussions
The Discussion tab on the GitHub page can be used for general questions, feedback, raising bugs or feature requests, or discussions related to these projects. Feel free to engage with other community members and share your ideas or suggestions.
Submit an issue
If you encounter a bug, have a feature request, or come across an explicit error, please submit an issue to the appropriate repository. Follow these guidelines for formatting the subject line:
- For bugs:
[BUG] - subject line - For feature requests:
[Feature Request] - subject line - For explicit errors:
[Error] - error message
Make sure to include which device you have (FxBlox or FxBlox Plus), app version number, what happened leading up to the issue, and the symptom you are experiencing. You can find logs under Settings -> Blox logs, please submit Go-Fula and Node logs if you can or applicable.
You can also follow the templates in Github to know what information to include in your post.
Submit a pull request (PR)
Contributions from the community are welcome. If you'd like to fix a bug, add a feature, or improve documentation, please submit a pull request. Make sure to follow our contribution guidelines and include a clear description of the changes you've made.
You can also follow the templates in Github to know what information to include in your post.
Choose the right repository
When deciding where to submit your issue or PR, consider where you encountered the problem or want to make a change:
- For issues within the FxBlox app or FxFiles: Submit to the fx-components repository.
- For issues with the firmware: Submit to the fula-ota repository.
- For issues related to the FxFotos app: Submit to the fx-fotos repository.
Please ensure that you submit your contribution to the appropriate repository based on where you experienced the issue or want to make a change. If you are unsure which repository to raise the concern in, start a Discussion thread so we can narrow down the problem!
Contribute to Fula docs
Technical writers of any level are greatly appreciated. If you are considering contributing to the documentation, please take a look at our Styling and Writing guides to learn more about our writing styles.
Thank you for contributing and helping build better software.