Skip to content

Commit 1fb7e52

Browse files
Update contributing instructions
1 parent 40a1f0b commit 1fb7e52

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
Contributing
2-
------------------
3-
This project is completely managed on GitHub using its [issue tracker](https://github.com/objectbox/objectbox-dart/issues).
1+
# Contributing
42

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.
66
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.
88
Don't hesitate to reach out for guidance or to discuss a solution proposal!
99

10-
### Code contributions
10+
## Code contributions
11+
1112
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.
1713

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+
1921
ObjectBox offers a [C API](https://github.com/objectbox/objectbox-c) which can be called by [Dart FFI](https://dart.dev/server/c-interop).
2022
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).
2123
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.

0 commit comments

Comments
 (0)