Skip to content

Commit 4358597

Browse files
committed
Add code of conduct and update readme to reference
1 parent d75f4f4 commit 4358597

File tree

2 files changed

+90
-18
lines changed

2 files changed

+90
-18
lines changed

CODE_OF_CONDUCT.md

+64
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

+26-18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Rust I2cdev
2-
===========
1+
# Rust I2cdev
32

43
[![Build Status](https://travis-ci.org/rust-embedded/rust-i2cdev.svg?branch=master)](https://travis-ci.org/rust-embedded/rust-i2cdev)
54
[![Version](https://img.shields.io/crates/v/i2cdev.svg)](https://crates.io/crates/i2cdev)
@@ -20,8 +19,7 @@ Linux can be found in
2019
[linux-embedded-hal](https://crates.io/crates/linux-embedded-hal) which, at
2120
present, uses this crate as the backend for I2C.
2221

23-
Example/API
24-
-----------
22+
## Example/API
2523

2624
The source includes an example of using the library to talk to a Wii
2725
Nunchuck (which has an i2c interface).
@@ -63,8 +61,7 @@ fn i2cfun() -> Result<(), LinuxI2CError> {
6361
In addition to the Read/Write traits, the following methods are
6462
available via the [I2CDevice trait](https://rust-embedded.github.io/rust-i2cdev/i2cdev/core/trait.I2CDevice.html).
6563

66-
Features
67-
--------
64+
## Features
6865

6966
The following features are implemented and planned for the library:
7067

@@ -79,22 +76,33 @@ The following features are implemented and planned for the library:
7976
- [ ] Add examples for non-smbus ioctl methods
8077
- [ ] Unit Testing
8178

82-
Cross Compiling
83-
---------------
79+
## Cross Compiling
8480

8581
Most likely, the machine you are running on is not your development
8682
machine (although it could be). In those cases, you will need to
8783
cross-compile. See https://github.com/japaric/rust-cross for pointers.
8884

89-
License
90-
-------
85+
## License
9186

92-
```
93-
Copyright (c) 2015, Paul Osborne <[email protected]>
87+
Licensed under either of
9488

95-
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
96-
http://www.apache.org/license/LICENSE-2.0> or the MIT license
97-
<LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
98-
option. This file may not be copied, modified, or distributed
99-
except according to those terms.
100-
```
89+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
90+
http://www.apache.org/licenses/LICENSE-2.0)
91+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
92+
93+
at your option.
94+
95+
### Contribution
96+
97+
Unless you explicitly state otherwise, any contribution intentionally submitted
98+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
99+
dual licensed as above, without any additional terms or conditions.
100+
101+
## Code of Conduct
102+
103+
Contribution to this crate is organized under the terms of the [Rust Code of
104+
Conduct][CoC], the maintainer of this crate, the [Embedded Linux Team][team], promises
105+
to intervene to uphold that code of conduct.
106+
107+
[CoC]: CODE_OF_CONDUCT.md
108+
[team]: https://github.com/rust-embedded/wg#the-embedded-linux-team

0 commit comments

Comments
 (0)