Contributing

How To Contribute

Thanks for looking here! We’d love your help. The micro:bit project is only possible through contributions of companies and individuals around the world.

This project is managed on GitHub, and the best way to contribute is to jump into the GitHub issue tracker to see what is available. Planned features are marked with the “enhancement” label, and know issues are marked with the “bug” label.

https://github.com/microbit-foundation/microbit-universal-hex/issues

If you’re interested in working on any of these items, please respond to an existing issue, or file a new one, and mention @microbit-carlos.

Code Of Conduct

Trust, partnership, simplicity and passion are our core values we live and breathe in our daily work life and within our projects. Our open-source projects are no exception. We have an active community which spans the globe and we welcome and encourage participation and contributions to our projects by everyone. We work to foster a positive, open, inclusive and supportive environment and trust that our community respects the micro:bit code of conduct.

Please see our code of conduct which outlines our expectations for all those that participate in our community and details on how to report any concerns and what would happen should breaches occur.

Bugs

Please report any bugs in the GitHub issue tracker: https://github.com/microbit-foundation/microbit-universal-hex/issues

Development Workflow

This project follows a fairly standard node.js process:

  • npm install to install dependencies
  • npm test runs the complete test suite
  • npm build creates a build of the library in all the output formats
  • npm docs builds the API documentation into the docs/api/ directory