Skip to content

Commit 87d2492

Browse files
aykevldeadprogram
authored andcommitted
CONTRIBUTING: add note on new APIs
1 parent cf51caa commit 87d2492

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ We probably have not implemented it yet. Your pull request adding the functional
1818

1919
Please open a Github issue. We want to help, and also make sure that there is no duplications of efforts. Sometimes what you need is already being worked on by someone else.
2020

21+
If your contribution includes a new API (one that does not exist yet for any BLE stack), please make sure it is portable:
22+
23+
* Ideally, add support for it to two different Bluetooth APIs at the same time, for example CoreBluetooth and BlueZ.
24+
* If you are unable to do so, please explain (with links to documentation!) why this feature also fits a different API.
25+
2126
## How to use our Github repository
2227

2328
The `release` branch of this repo will always have the latest released version of the Go Bluetooth module. All of the active development work for the next release will take place in the `dev` branch. The Go Bluetooth module will use semantic versioning and will create a tag/release for each release.

0 commit comments

Comments
 (0)