Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.36 KB

Contributing

Reporting bug

Please report the bug you find on lichess-org/lichobile/issues. Be sure to search in the existing issues before in order to avoid duplicates.

Bug reports MUST contain:

  • phone hardware
  • phone operating system version
  • version of lichess mobile beta
  • steps to reproduce
  • description of the observed behavior
  • description of the expected behavior

If you have an Android device you can use remote debugging tools.

Sending Javascript errors with your bug report is extremely helpful.

Please do not report mobile application bugs in lichess forum.

Pull requests

Check the requirements and setup guide in the readme.

We use eslint to enforce some coding conventions.

Before sending a pull request, please ensure the following commands run without error:

$ npm run lint
$ npm run test

Caveats

Mithril views should be written with the hyperscript function (imported as h), and not JSX. Current JSX views are here for legacy reasons.

Mithril is used only to write views via the module mithril/hyperscript. We do not use any of the framework api, such as m.route, m.request, etc.

The redraw logic is also custom. Thus, if you need to re-render the view, you want to use the ~/utils/redraw module instead of m.redraw.