You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project is completely managed on GitHub using its [issue tracker](https://github.com/objectbox/objectbox-dart/issues).
1
+
# Contributing
4
2
5
-
Anyone can contribute, be it by coding, improving docs or just proposing a new feature.
3
+
For public issues see the [GitHub issue tracker](https://github.com/objectbox/objectbox-dart/issues).
4
+
5
+
We welcome smaller contributions, be it by coding, improving docs or just proposing a new feature.
6
6
Look for tasks having a [**"help wanted"**](https://github.com/objectbox/objectbox-dart/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag.
7
-
When picking up an existing issue, please let us know in the issue comment.
7
+
When picking up an existing issue, please talk to us beforehand by commenting in the issue.
8
8
Don't hesitate to reach out for guidance or to discuss a solution proposal!
9
9
10
-
### Code contributions
10
+
## Code contributions
11
+
11
12
When creating a Pull Request for code changes, please check that you cover the following:
12
-
* Include tests for the changes you introduce. See the [test folder](objectbox/test) for examples.
13
-
* Formatted the code using `dartfmt -l 120`. You can configure your IDE to do this automatically,
14
-
e.g. VS Code needs the project-specific settings `"editor.defaultFormatter": "Dart-Code.dart-code"` and `"dart.lineLength": 120`.
15
-
* Update the `## latest` section in the `CHANGELOG.md` - add a single-line comment what changes.
16
-
This only applies if the change is "external", i.e. it affects objectbox-dart library users.
17
13
18
-
### Basic technical approach
14
+
- Include tests for the changes you introduce. See the [test package](objectbox_test) for examples.
15
+
- Formatted your changes using `dart format`.
16
+
- If the change affects users of this library, update the `## latest` section in the `CHANGELOG.md`
17
+
by adding a single-line comment what changes.
18
+
19
+
## Basic technical approach
20
+
19
21
ObjectBox offers a [C API](https://github.com/objectbox/objectbox-c) which can be called by [Dart FFI](https://dart.dev/server/c-interop).
20
22
The C API is also used by the ObjectBox language bindings for [Go](https://github.com/objectbox/objectbox-go), [Swift](https://github.com/objectbox/objectbox-swift), and [Python](https://github.com/objectbox/objectbox-python).
21
23
These languages may serve as an inspiration for this Dart implementation.
22
-
Internally, ObjectBox uses [FlatBuffers](https://google.github.io/flatbuffers/) to store objects.
24
+
Internally, ObjectBox uses [FlatBuffers](https://google.github.io/flatbuffers/) to store objects.
@@ -95,7 +95,6 @@ Oh, and there is one more thing...
95
95
96
96
😮 [**Data Sync**](https://objectbox.io/sync/) - keeps data in sync offline or online, between devices and servers.
97
97
98
-
99
98
## Getting Started
100
99
101
100
Continue with our ➡️ **[Getting Started guide](https://docs.objectbox.io/getting-started)**. It has resources and video tutorials on how to use ObjectBox in your Flutter or Dart app.
@@ -110,7 +109,7 @@ Continue with our ➡️ **[Getting Started guide](https://docs.objectbox.io/get
110
109
111
110
We tested across the four main database operations, CRUD (create, read, update, delete). Each test was run multiple times and executed manually outside of the measured time. Data preparation and evaluation were done outside of the measured time.
112
111
113
-
Here are the benchmarks for ObjectBox vs sqflite vs Hive 👇
112
+
Here are the benchmarks for ObjectBox vs sqflite vs Hive (last updated 2021-09-11) 👇
@@ -102,6 +103,7 @@ Read the ➡️ **[Getting Started guide](https://docs.objectbox.io/getting-star
102
103
It has resources and video tutorials on how to use ObjectBox in your Flutter or Dart app.
103
104
104
105
We also have some video tutorials, each featuring a different example app:
106
+
105
107
-[Shop order app](https://youtu.be/AxYbdriXKI8)
106
108
-[Restaurant: chef and order apps](https://youtu.be/r9Lc2r22KBk)
107
109
-[Task-list app (in Spanish)](https://youtu.be/osUq6B92-BY)
@@ -111,7 +113,7 @@ We also have some video tutorials, each featuring a different example app:
111
113
112
114
We tested across the four main database operations, CRUD (create, read, update, delete). Each test was run multiple times and executed manually outside of the measured time. Data preparation and evaluation were also done outside of the measured time.
113
115
114
-
Here are the benchmarks for ObjectBox vs sqflite vs Hive 👇
116
+
Here are the benchmarks for ObjectBox vs sqflite vs Hive (last updated 2021-09-11) 👇
0 commit comments