Skip to content

Commit 5ab5219

Browse files
Merge #415
415: [RFC] Changing the way we handle addition/changes to the traits r=ryankurte a=therealprof [Rendered](https://github.com/rust-embedded/wg/blob/revising-unproven/rfcs/0415-revising-unproven.md) Co-authored-by: Daniel Egger <[email protected]>
2 parents 09a87b0 + 7911a21 commit 5ab5219

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

rfcs/0415-revising-unproven.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
- Feature Name: Changing the way we handle addition/changes to the embedded-hal traits
2+
- Start Date: 2019-11-12
3+
- RFC PR: https://github.com/rust-embedded/wg/pull/415/
4+
- Rust Issue: (leave this empty)
5+
6+
# Summary
7+
[summary]: #summary
8+
9+
This proposal proposes to change the way how we make additions and changes to the `embedded-hal` traits in order to break the radio silence.
10+
11+
# Motivation
12+
[motivation]: #motivation
13+
14+
Our current approach to changes is to open an RFC issue/PR, propose a trait, discuss it extensively and then maybe add it under the `unproven` feature flag -- or often not. In essence this means that all proposals are somewhat theoretical, reluctantly implemented and the `unproven` feature gates usually never get removed due to a lack of motivation to do that extra work which also leads to everyone uncoditionally enabling the `unproven` feature.
15+
16+
This is not very efficient for the community and stifles implementation and innovation.
17+
18+
This RFC attempts to change from a theoretical approach to a more real life approach by favouring working implementations over dry discussion.
19+
20+
# Detailed design
21+
[design]: #detailed-design
22+
23+
This RFC suggests a more progressive approach by changing the way the crate works and the way we accept new additions and changes.
24+
25+
## Disabling the problematic `unproven` feature
26+
27+
This crate should only contain proven traits, hence all existing traits should be automatically considered proven (also to not break compatibility) and thus all feature gates removed and the feature itself turned into a no-op.
28+
29+
If a trait does not yet provide the expected quality, a new version can easily added under the new rules explained below.
30+
31+
## Accepting new additions
32+
33+
Instead of discussing a trait, adding it and hoping for implementations, all proposed changes should be required to demonstrate their usefulness by pointing to at least **two** independent and different implementations and at least one example utilizing the implementations. The implementations can live in separate branches or PRs of two or more repositories, are meant to demonstrate that the proposed traits can be implemented for arguably different hardware and are usable.
34+
35+
Based on these requirements a more meaningful and interactive discussion can take place, eventually resulting in acceptance of the aditions with working implementations already in hand.
36+
37+
# How We Teach This
38+
[how-we-teach-this]: #how-we-teach-this
39+
40+
The new process would be documented accordingly so interested parties can easily follow it.
41+
42+
# Drawbacks
43+
[drawbacks]: #drawbacks
44+
45+
None known.
46+
47+
# Alternatives
48+
[alternatives]: #alternatives
49+
50+
Don't implement this RFC.
51+
52+
# Unresolved questions
53+
[unresolved]: #unresolved-questions
54+
55+
* How many implementations do we require? Are two enough?
56+
* Do we want to make a sufficient seperation of the mandatory implementations a hard requirement or a soft one? And if it's a hard requirement what would be the metrics for it?

0 commit comments

Comments
 (0)