Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.48 KB

Contributing

For public issues see the GitHub issue tracker.

We welcome smaller contributions, be it by coding, improving docs or just proposing a new feature. Look for tasks having a "help wanted" tag. When picking up an existing issue, please talk to us beforehand by commenting in the issue. Don't hesitate to reach out for guidance or to discuss a solution proposal!

Code contributions

When creating a Pull Request for code changes, please check that you cover the following:

  • Include tests for the changes you introduce. See the test package for examples.
  • Formatted your changes using dart format.
  • If the change affects users of this library, update the ## latest section in the CHANGELOG.md by adding a single-line comment what changes.

Basic technical approach

ObjectBox offers a C API which can be called by Dart FFI. The C API is also used by the ObjectBox language bindings for Go, Swift, and Python. These languages may serve as an inspiration for this Dart implementation. Internally, ObjectBox uses FlatBuffers to store objects.