Requirements for Blocklets from Open Source Github Projects
As discussed here 🐑了个🐑 小游戏 , it is permissible to develop and release blocklets derived from open-source GitHub projects. It is imperative that these blocklets adhere to specific criteria in order to prevent any potential misunderstandings or disputes。
Basic Requirements
- The blocklet.yml file must include a repository link to the original GitHub repository (reference).
- The blocklet.yml file must feature a homepage link directing to the original GitHub repository.
- The blocklet.yml file must be governed by the same license as the original GitHub repository.
- It is recommended that the blocklet title/description and logo closely resemble the resources found in the original GitHub repository for consistency and branding purposes.
By ensuring that these requirements are met, we can maintain clarity and transparency in the development and distribution of blocklets sourced from open-source projects.
Extra Requirements
Several technical considerations should be taken into account to enhance the robustness of blocklets sourced from open-source GitHub repositories:
- For blocklets that function as web applications running in browsers, it is recommended to utilize Static Server as their runtime (reference). This is advised as the "static" blocklet group will be deprecated in future releases.
- If the blocklet incorporates resources from external services, it is crucial to ensure that these resources are localized. External services may restrict access to resources when utilized within a blocklet environment. like the issue reported here: test store 图片显示问题
- It is essential to ensure that the blocklet is capable of functioning on any mount point. This can be achieved by loading resources from relative paths of the "index.html" file. This approach is key to ensuring the blocklet's compatibility across various environments.
One more thing
We warmly welcome developers from the community to build applications, whether based on existing projects or starting from scratch. The requirements mentioned above are our initial thoughts, and we reserve the right to update them as necessary.
1 条回复
This is very helpful, thanks for the further clarifications!
About the point:
“It is recommended that the blocklet title/description and logo closely resemble the resources found in the original GitHub repository for consistency and branding purposes.”
^ This depends on the license for the open software. For example, for a BSD3 license those things might have to be changed. But the recommendation is noted