Skip to content

Home

Jump to bottom
djinoz edited this page Feb 26, 2024 · 3 revisions

Free to use

GuideBlocks are free for you to use, just be aware they are a community resource and are provided as-is, if something is not working or not exactly what you want for you consider submit fixes or enhancements.

Contributions Welcome

You are welcome to use any of these GuideBlocks or Contribute. For more information check the README

To contribute or fix/improve a GuideBlock, here is the process:

  1. Fork from main
  2. Commit and make a PR for your changes to "develop" branch.
  3. Commit and make a PR for the invocation of your GuideBlock in the Android sample app or the iOS sample app
  4. When we merge the PR, it will trigger a build
  5. We will QA
  6. If it passes, your GuideBlock will be merged to "main"
  7. If it fails, we may fix it or make a ticket here.

QA rejection

Here are some of the reasons:

  • Guideblock.yaml or README.md are incorrect or missing important info
    • you didn't credit the original author of any dependency
    • ownership or licence issues
    • you're image, video are wrong. They CAN be empty, just not wrong.
    • missing Extensibility JSON
  • significant departure from the original GuideBlock's intent (it may be better you just copy it and make a new GuideBlock from it - ensure you credit authors in your new GuideBlock)
  • merge conflicts
  • you new GuideBlock MUST have a unique directory name in the repo under the GuideBlocks directory.
  • everything you need must be self-contained below that directory and any dependencies must be resolvable
  • Functionality, crashes etc

Minor QA Fails

A GB can fail QA but still be merged to main when the issues are cosmetic or do not implement ALL relevant dashboard fields where appropriate. e.g if you have a title text and have put the font-family, size etc in the Extensibility JSON, it would be better that you parse and use the GuidePayload JSON for "title".

Clone this wiki locally