Thanks for thinking about contributing to Espruino! Anything you can add is hugely appreciated, but please can you follow a few simple rules:
First, please try and check that your problem hasn't already been found or covered on our forum.
Do not post 'it doesn't work for me' / 'I can't connect' / 'How do I make a foobar' issues. Please ask these on the forum where you will get a much more helpful response. Issues posted here should be for actual software bugs or feature requests.
Submit bugs with clear steps to reproduce them: a minimal test case, and an actual and expected result. If you can't come up with these, please post on the forum first as it may just be something in your code that we can help out with.
Work on Espruino is supported by sales of our boards.
If your board isn't made by us but came pre-installed with Espruino then you should contact the manufacturers.
We try and support users of the boards we sell, but if you bought a non-official board your issue may not get addressed. In this case, please consider donating to help cover the time it takes to fix problems (even so, we can't guarantee to fix every problem).
Improvements to Documentation are amazingly helpful, and are very rare so hugely appreciated.
If you want to change something in a built-in function's documentation, look at the heading for the function on that page and there will be a right-arrow (⇒).
If you click on that it will bring you to the area of Espruino's source code where the function and the documentation for it are stored. You can then edit the documentation in that file (above the function) on GitHub and issue a pull request - it's in Markdown format.
Please see here
If there's something specific to an area of the Espruino interpreter that can't be put in a source file, please create a Markdown (.md
) file in the relevant area, and make sure you link to it from other relevant files so it can be found.
Please see here
We'll keep the outstanding issues in GitHub's issue list, but general stuff that would really help us is:
build_platform_info.py
using the board definition file.The rough coding style is as follows, but you should get a good idea from the code. If we've missed anything obvious please let us know!
CR
, not CR LF
for newlines)bool
for booleans - not int
//
comments for single lines, /* ... */
for multiple lines///<
for function/variable declaration documentation (if on same line), and /** ... */
if doing it right before a functionsetFooBar // This sets the Foo to Bar
style comments to functions/variables. Only add comments if they add something that is not obvious from the declaration itself
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。