micro:bit makecode extension approval

Please fill out this form to submit your makecode extension for approval. On submission you will receive an automated email from our support system with a ticket number. We will use this ticket to communicate with you about the submission.

Once we are satisfied that your extension meets requirements (see this example repo), we will submit a Pull Request to the pxt-microbit GitHub Repository to update targetconfig.json and makecode.microbit.org/extensions files with your information.

Please check and confirm the following:* This field is required.Run through this checklist before you submit your extension for approval

This extension supports a commercially available micro:bit accessory or sensor, and/or is intended for use in education and is in alignment with the Foundation's mission statement https://microbit.org/about/#mission-statement

You have submitted the accessory for inclusion in the micro:bit accessories list https://form.jotformeu.com/83453273451355

The extension uses DAL/CODAL and does not make use of mBed. We cannot approve extensions that use the mBed layer as it is only supported on V1 of the micro:bit.

The extension is primarily written in English (block translations are very welcome)

The repository contains an icon.png to aid search. (Please ensure the icon is 300 x 200pixels and less than 100Kb in size as users will need to download it)

The extension is MIT licensed (https://tldrlegal.com/license/mit-license). This licensing is easy to understand and use and ensures sustainability.

The README contains a link to the product page or blog entry.

The README contains well commented examples of use, using TypeScript or embedded editor elements, rather than screengrabs/images. It should be written so that a teacher can easily understand it's purpose and use.

The README contains links to further educational materials and tutorials

Blocks are lowercased unless they refer to acronyms.

Blocks have tooltips and links to online help using the Makecode Markdown system.

You have provided a test suite (test.ts) within the extensions(s). The test suite should be comprehensive enough that if Microsoft (who run MakeCode) or the Micro:bit Educational Foundation make any underlying changes to the way the micro:bit compilation happens, we can be sure that your programs and blocks will still work. Tests should cover all functionality and be documented so that it's clear how to test it, what to expect and what it is considered a pass/fail. If should not throw errors in the simulator if it is using non simulated hardware.

You are a member of the micro:bit development community on Slack and have joined the #makecode , #makecode-extensions and #makecode-tutorials channels. More information on joining the community can be found at https://tech.microbit.org/community

TypeScript follows usual JavaScript notations: camelCase for functions, namespace, class members; UPPERCASE for class names, enum/enum members.

The extension is in a finished state. Extensions that are in development should be marked 'beta' in the repository description.

Contact email address* This field is required.Email address of person responsible for maintaining the extension and tutorials

example@example.com

Contact phone numberTelephone number of organisation or contact responsible for maintaining the extension and tutorials

Area Code

Phone Number

Github URL for the extension* This field is required.The direct link or for organisation approval the link to the Repo/Account

Maintainer/Support GitHub ID* This field is required.GitHub ID of someone we can mention in issues

microbit-community Slack ID* This field is required.Slack ID of person responsible for development of the extension. More information on joining the community can be found at https://tech.microbit.org/community/#join-us-on-the-microbit-community-slack-channel

Link to product page* This field is required.Link to product page to purchase the accessory or find out more. This link must also be included in the README.md on GitHub

Does your extension have an associated Tutorial?https://makecode.com/writing-docs/user-tutorials

YESNO

Github link for the tutorialPlease provide a link to the tutorial eg https://github.com/microbit-foundation/pxt-microbit-v2-power/blob/master/basic-sleep-wake.md

Which micro:bit version(s) does the extension supporthttps://support.microbit.org/support/solutions/articles/19000119162-how-to-identify-the-version-number-of-your-micro-bit- You can also include a logo to identify which boards the extension supports https://microbit.org/brand-guidelines/#when-can-i-use-the-micro:bit-compatibility-logo

micro:bit V1 and V2

micro:bit V2 only

micro:bit V1 only

i2c address(es)If your accessory makes use of the i2c bus, please list the addresses used.

eg 0x76, 0x29

Pin allocationIf the accessory allocates a pin to a specific functionality, please list all the pins allocated and in what configuration (digital, analog, pwm, SPI, I2C, UART, etc).

Does The Foundation have already have examples of your accessory?* This field is required.I have forwarded 3 accessories to micro:bit for ongoing support.

YESNO

We would like 3 pieces of your accessory to use within the Foundation for marketing and support. We are currently migrating our accessory storage and will reach out to you if we require hardware to be sent.

By submitting the form, you agree to the following:

In cases where there is an issue with the extension that is reported on your repository, you will resolve it in a timely manner. The foundation reserve the right to remove extensions from the approved list if issues remain unresolved, or the use of the extension diminishes the user experience in MakeCode.
The Foundation may contact you from time to time with information about MakeCode extensions and the BBC micro:bit.