Skip to content
Gordon Williams edited this page Sep 4, 2023 · 13 revisions

This page is still a work in progress

When contributing a new app, you should check out the Bangle.js tutorials - specifically http://www.espruino.com/Bangle.js+App+Loader

Before merging, we'll check:

  • The CI tests for a PR complete successfully
  • The PR doesn't include changes to other apps that aren't mentioned
  • The PR doesn't include temporary/accidentally committed files
  • Compatibility with current stable firmware version (and maybe most recent?)
  • Compatibility with dark/bright themes
  • Useful/correct metadata
    • storage files listed
    • data files if settings are used
    • supported hardware
    • tags
    • type(if a clock or not an app)
  • If a new library is used in the repository
    • Have a look at licenses
    • See if it was already used in the repo and stored globally (eg suncalc)
  • Get another person (at first @gfwilliams) to get a view at the PR if:
    • Some default for multiple apps is changed
    • "Basic" apps like Android, Bootloader, Settings etc. are changed in a relevant way

Nice to have:

  • Screenshots - on Bangle.js 2 you can run g.dump() in the IDE console to get these
  • We're not fond of you refactoring of apps to your personal style - best stick with the code style used for that particular app. And if for some reason you have to refactor it should be in a separate commit so we can see what actually changed.
Clone this wiki locally