Skip to content

Commit 9c20f47

Browse files
posborneposborne
committed
Add code of conduct and update readme to reference
1 parent 6c937b9 commit 9c20f47

File tree

2 files changed

+91
-20
lines changed

2 files changed

+91
-20
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# The Rust Code of Conduct
2+
3+
## Conduct
4+
5+
**Contact**: [Embedded Linux Team][team]
6+
7+
* We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
8+
* On IRC, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
9+
* Please be kind and courteous. There's no need to be mean or rude.
10+
* Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
11+
* Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
12+
* We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term "harassment" as including the definition in the [Citizen Code of Conduct](http://citizencodeofconduct.org/); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.
13+
* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [Embedded Linux Team][team] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.
14+
* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
15+
16+
## Moderation
17+
18+
These are the policies for upholding our community's standards of conduct.
19+
20+
1. Remarks that violate the Rust standards of conduct, including hateful,
21+
hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is
22+
allowed, but never targeting another user, and never in a hateful manner.)
23+
2. Remarks that moderators find inappropriate, whether listed in the code of
24+
conduct or not, are also not allowed.
25+
3. Moderators will first respond to such remarks with a warning.
26+
4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of
27+
the communication channel to cool off.
28+
5. If the user comes back and continues to make trouble, they will be banned,
29+
i.e., indefinitely excluded.
30+
6. Moderators may choose at their discretion to un-ban the user if it was a
31+
first offense and they offer the offended party a genuine apology.
32+
7. If a moderator bans someone and you think it was unjustified, please take it
33+
up with that moderator, or with a different moderator, **in private**.
34+
Complaints about bans in-channel are not allowed.
35+
8. Moderators are held to a higher standard than other community members. If a
36+
moderator creates an inappropriate situation, they should expect less leeway
37+
than others.
38+
39+
In the Rust community we strive to go the extra step to look out for each other.
40+
Don't just aim to be technically unimpeachable, try to be your best self. In
41+
particular, avoid flirting with offensive or sensitive issues, particularly if
42+
they're off-topic; this all too often leads to unnecessary fights, hurt
43+
feelings, and damaged trust; worse, it can drive people away from the community
44+
entirely.
45+
46+
And if someone takes issue with something you said or did, resist the urge to be
47+
defensive. Just stop doing what it was they complained about and apologize. Even
48+
if you feel you were misinterpreted or unfairly accused, chances are good there
49+
was something you could've communicated better — remember that it's your
50+
responsibility to make your fellow Rustaceans comfortable. Everyone wants to get
51+
along and we are all here first and foremost because we want to talk about cool
52+
technology. You will find that people will be eager to assume good intent and
53+
forgive as long as you earn their trust.
54+
55+
The enforcement policies listed above apply to all official embedded WG venues;
56+
including official IRC channels (#rust-embedded); GitHub repositories under
57+
rust-embedded; and all forums under rust-embedded.org (forum.rust-embedded.org).
58+
59+
*Adapted from the [Node.js Policy on
60+
Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the
61+
[Contributor Covenant
62+
v1.3.0](https://www.contributor-covenant.org/version/1/3/0/).*
63+
64+
[team]: https://github.com/rust-embedded/wg#the-embedded-linux-team

‎README.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ You might want to also check out the
2121
convenient way to associate names with pins and export them as part of system
2222
boot. That project uses this library.
2323

24-
Install/Use
25-
-----------
24+
## Install/Use
2625

2726
To use `sysfs_gpio`, first add this to your `Cargo.toml`:
2827

@@ -37,8 +36,7 @@ Then, add this to your crate root:
3736
extern crate sysfs_gpio;
3837
```
3938

40-
Example/API
41-
-----------
39+
## Example/API
4240

4341
Blinking an LED:
4442

@@ -70,8 +68,7 @@ More Examples:
7068
- [Poll several pins asynchronously with Tokio](examples/tokio.rs)
7169
- [gpio-utils Project (uses most features)](https://github.com/rust-embedded/gpio-utils)
7270

73-
Features
74-
--------
71+
## Features
7572

7673
The following features are planned for the library:
7774

@@ -86,16 +83,14 @@ The following features are planned for the library:
8683
- [x] Support for asynchronous polling using `mio` or `tokio-core` (requires
8784
enabling the `mio-evented` or `tokio` crate features, respectively)
8885

89-
Cross Compiling
90-
---------------
86+
## Cross Compiling
9187

9288
Most likely, the machine you are running on is not your development
9389
machine (although it could be). In those cases, you will need to
9490
cross-compile. The [rust-cross guide](https://github.com/japaric/rust-cross)
9591
provides excellent, detailed instructions for cross-compiling.
9692

97-
Running the Example
98-
-------------------
93+
## Running the Example
9994

10095
Cross-compiling can be done by specifying an appropriate target. You
10196
can then move that to your device by whatever means and run it.
@@ -105,15 +100,27 @@ $ cargo build --target=arm-unknown-linux-gnueabihf --example blinky
105100
$ scp target/arm-unknown-linux-gnueabihf/debug/examples/blinky ...
106101
```
107102

108-
License
109-
-------
103+
## License
110104

111-
```
112-
Copyright (c) 2015, Paul Osborne <ospbau@gmail.com>
105+
Licensed under either of
113106

114-
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
115-
http://www.apache.org/license/LICENSE-2.0> or the MIT license
116-
<LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
117-
option. This file may not be copied, modified, or distributed
118-
except according to those terms.
119-
```
107+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
108+
http://www.apache.org/licenses/LICENSE-2.0)
109+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
110+
111+
at your option.
112+
113+
### Contribution
114+
115+
Unless you explicitly state otherwise, any contribution intentionally submitted
116+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
117+
dual licensed as above, without any additional terms or conditions.
118+
119+
## Code of Conduct
120+
121+
Contribution to this crate is organized under the terms of the [Rust Code of
122+
Conduct][CoC], the maintainer of this crate, the [Embedded Linux Team][team], promises
123+
to intervene to uphold that code of conduct.
124+
125+
[CoC]: CODE_OF_CONDUCT.md
126+
[team]: https://github.com/rust-embedded/wg#the-embedded-linux-team

0 commit comments

Comments
 (0)