abandonware / noble

A Node.js BLE (Bluetooth Low Energy) central module : Community maintained
https://libraries.io/npm/@abandonware%2Fnoble
MIT License
542 stars 160 forks source link

Co maintenance #9

Open rzr opened 5 years ago

rzr commented 5 years ago

As I said, elsewhere as creator of @abandonware org, I am open to co maintainership, but it's hard to trust everyone, specially when taking over orphan packages. So I don't want to put users under any risk.

In short term, I propose this rule:

Any developer can apply but he should already has committed to an opensource organisation that he will behave nicely (to not intentionally commit malicious code), An explicit proof of commitment should be provided too.

Related links:

I am open to suggestions.

Tracking changes is also welcome, ask me how if unsure:

marksyzm commented 5 years ago

I'm up for this, for noble at least. I use a Mac on Mojave but am used to working across all the platforms including mobile?

qdot commented 5 years ago

cc @jrobeson, who also has a noble fork with a lot of updates/changes.

ghost commented 5 years ago

In this case it wouldn't be abandonware at all then. If folks are interested in my refactorings, then it should probably get a new name and be redone as a monorepo. That's what I planned on doing.

Feel free to take a look at my changes https://github.com/jrobeson/noble/commits/refactor

ghost commented 5 years ago

Currently i'm attempting to refactor the hci-socket bindings to prepare for a merge of bleno code.

rzr commented 5 years ago

Any mac developer interested to review: https://github.com/abandonware/noble/pull/8 ?

qdot commented 5 years ago

While I'm not a great low level mac developer, I have my own fork that combines noble-mac and @abandonware/noble for running across linux/mac, and it's been working ok for me so far.

https://github.com/qdot/noble-mac/tree/abandonware-fork

I've also had some luck with noble-uwp too on windows 10, though I mostly use straight C# there.

rzr commented 5 years ago

@qdot would you like to co-maintain noble here and join @abandonware/maintainers to merge current open PR ?

Before, please send a PR that add your name to a file "MAINTAINERS.md" and add a message that you comply to contribute for community interest and do not plan do malicious things, the commit should be verified too, I can provide an example if unclear.

Regards

marksyzm commented 5 years ago

@qdot does that mean it works across other platforms too?

ghost commented 5 years ago

So what's the end goal of this comaintainership? Just to keep things working, or make significant changes?

rzr commented 5 years ago

First merge fixes still under review upstream... and avoid to break API until upstream is open to new developments.

So if you have experimental features, they could be based on @abandonware master or eventually in a "experimental" branch (eg: "sandbox/$user/master" )

ghost commented 5 years ago

I'm a bit beyond that at this point, so I guess i shouldn't apply for now. I already broke the API by requiring const noble = new Noble() to simplify a lot of other parts.

marksyzm commented 5 years ago

The API needs an update/rewrite, for sure. There's lots of undocumented stuff too.

rzr commented 5 years ago

one solution would be to add in, a transition module that will add new unstable APIs like:

const noble = requiere('abandonware/noble/experimental');
qdot commented 5 years ago

@rzr Unfortunately I'm not sure I'm best for maintainership on this for the moment. I deal with way too many projects as is right now, and while noble is an important component in of some of them, it's not really something I can split more time onto. I've just been sharing what I've done lately to get my system working.

@marksyzm Inasmuch as any noble will "Work across other platforms". My fork just has a dynamic load path that checks for platforms at runtime. If it's darwin, it chooses noble-mac. If it's not, it chooses @abandonware/noble. Could be at some point I'll add another path to choose noble-uwp on win10. That's all it does, tho, nothing all that special.

rzr commented 5 years ago

I am drafting a constitution for @abandonware/maintainers @abandonware/owners

Any suggestions are welcome: https://github.com/abandonware/abandonware.github.io/blob/master/index.md

rzr commented 5 years ago

There is only one maintainer (myself), who want to be next ? https://github.com/abandonware/noble/blob/master/MAINTAINERS.md

Please follow instructions at:

Also feedback from @sandeepmistry is welcome

@qdot I released a version, can you rebase your branch on @abandonware/maintainers 's master and Open PR on relevant changes:

https://github.com/qdot/noble-mac/tree/abandonware-fork

Relate-to: https://social.samsunginter.net/@rzr/101930569288659296

rzr commented 3 years ago

Based on @atrovato contributions may I propose him to join this list: https://github.com/abandonware/noble/blob/master/MAINTAINERS.md