[RFC] establish a process for adding new traits #39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'd love to be a collaborator. |
therealprof
reviewed
Feb 14, 2018
README.md
Outdated
|
|
||
| To leave the unproven state at least *two* implementations of the trait(s) for different platforms | ||
| (ideally, the two platforms should be from different vendors) and *one* generic driver built on top | ||
| of the trait(s) must be demonstrated. If, instead, reports indicate that the proposed trait(s) can't |
There was a problem hiding this comment.
There might be cases where a trait is purely internal and/or may not have any drivers using it, like timers, ADCs, RNGs... in that case a full example demonstrating the use should suffice, I think.
There was a problem hiding this comment.
I think that's a fair observation. Maybe the requirements should be worded less strongly and be treated as more of a guideline.
|
LGTM. Happy to help. |
hannobraun
reviewed
Feb 15, 2018
README.md
Outdated
|
|
||
| To leave the unproven state at least *two* implementations of the trait(s) for different platforms | ||
| (ideally, the two platforms should be from different vendors) and *one* generic driver built on top | ||
| of the trait(s) must be demonstrated. If, instead, reports indicate that the proposed trait(s) can't |
There was a problem hiding this comment.
I think that's a fair observation. Maybe the requirements should be worded less strongly and be treated as more of a guideline.
README.md
Outdated
|
|
||
| [`tm4c123x-hal`]: https://github.com/thejpster/tm4c123x-hal | ||
|
|
||
| You may be able to find even more implementations by searching for the [`embedded-hal-impl`] keyword |
There was a problem hiding this comment.
I think this paragraph is important, but it's easy to miss down here. A casual reader might think it's a note about TI. I suggest moving it up, making it the second paragraph under ## Implementations.
README.md
Outdated
|
|
||
| [`si7021`]: https://github.com/wose/si7021 | ||
|
|
||
| You may be able to find even more implementations by searching for the [`embedded-hal-driver`] |
There was a problem hiding this comment.
This paragraph is less easy to miss, since there are no sub-sections, but I'd still move it above the list of links.
|
Thanks everyone for the feedback. I've incorporated the suggestions. As there's no objection let's land this! @homunkulus r+ @thejpster @therealprof @hannobraun I've send y'all invites. Thanks for helping out ❤️ |
|
📌 Commit bfa0786 has been approved by |
japaric
pushed a commit
that referenced
this pull request
Feb 15, 2018
[RFC] establish a process for adding new traits This PR establish a process for adding new traits. The details can be found in the diff. This PR is also proposing using the `embedded-hal-driver` and `embedded-hal-impl` keywords on crates.io to make implementations of `embedded-hal` and drivers built on top of it more discoverable. Feel free to suggest changes to these proposals in the comments. The PR is also adding a list of (WIP) `embedded-hal` implementations and `embedded-hal` drivers. If your crate is not listed there or if you know of a crate that should be there feel free to send a follow up PR adding it. --- Finally, I'd like to use this chance to call for collaborators that will help me with: - Merging PRs that update the lists in the README - Triaging issues to make sure that they are properly labeled and that they are following the established process. - "Shepherding" proposals / discussions by preventing them from going off topic and by helping them reach a conclusion / consensus, e.g. "Concern $X needs to be addressed before reaching a conclusion", "How would this proposal fulfill use case $Y?", etc. If you'd like to become a collaborator let me know in the comments!
|
💡 This pull request was already approved, no need to approve it again.
|
|
📌 Commit bfa0786 has been approved by |
japaric
pushed a commit
that referenced
this pull request
Feb 15, 2018
[RFC] establish a process for adding new traits This PR establish a process for adding new traits. The details can be found in the diff. This PR is also proposing using the `embedded-hal-driver` and `embedded-hal-impl` keywords on crates.io to make implementations of `embedded-hal` and drivers built on top of it more discoverable. Feel free to suggest changes to these proposals in the comments. The PR is also adding a list of (WIP) `embedded-hal` implementations and `embedded-hal` drivers. If your crate is not listed there or if you know of a crate that should be there feel free to send a follow up PR adding it. --- Finally, I'd like to use this chance to call for collaborators that will help me with: - Merging PRs that update the lists in the README - Triaging issues to make sure that they are properly labeled and that they are following the established process. - "Shepherding" proposals / discussions by preventing them from going off topic and by helping them reach a conclusion / consensus, e.g. "Concern $X needs to be addressed before reaching a conclusion", "How would this proposal fulfill use case $Y?", etc. If you'd like to become a collaborator let me know in the comments!
|
☀️ Test successful - status-travis |
|
@japaric I'd be happy to help too! |
|
@ilya-epifanov Thanks! I've sent you an invite. |
scowcron
pushed a commit
to scowcron/embedded-hal
that referenced
this pull request
Feb 28, 2018
[RFC] establish a process for adding new traits This PR establish a process for adding new traits. The details can be found in the diff. This PR is also proposing using the `embedded-hal-driver` and `embedded-hal-impl` keywords on crates.io to make implementations of `embedded-hal` and drivers built on top of it more discoverable. Feel free to suggest changes to these proposals in the comments. The PR is also adding a list of (WIP) `embedded-hal` implementations and `embedded-hal` drivers. If your crate is not listed there or if you know of a crate that should be there feel free to send a follow up PR adding it. --- Finally, I'd like to use this chance to call for collaborators that will help me with: - Merging PRs that update the lists in the README - Triaging issues to make sure that they are properly labeled and that they are following the established process. - "Shepherding" proposals / discussions by preventing them from going off topic and by helping them reach a conclusion / consensus, e.g. "Concern $X needs to be addressed before reaching a conclusion", "How would this proposal fulfill use case $Y?", etc. If you'd like to become a collaborator let me know in the comments!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR establish a process for adding new traits. The details can be found in the diff. This PR is
also proposing using the
embedded-hal-driverandembedded-hal-implkeywords on crates.io to makeimplementations of
embedded-haland drivers built on top of it more discoverable.Feel free to suggest changes to these proposals in the comments.
The PR is also adding a list of (WIP)
embedded-halimplementations andembedded-haldrivers. Ifyour crate is not listed there or if you know of a crate that should be there feel free to send a
follow up PR adding it.
Finally, I'd like to use this chance to call for collaborators that will help me with:
Merging PRs that update the lists in the README
Triaging issues to make sure that they are properly labeled and that they are following the
established process.
"Shepherding" proposals / discussions by preventing them from going off topic and by helping them
reach a conclusion / consensus, e.g. "Concern $X needs to be addressed before reaching a
conclusion", "How would this proposal fulfill use case $Y?", etc.
If you'd like to become a collaborator let me know in the comments!