Skip to content

Commit d691889

Browse files
authored
Merge pull request #7 from posborne/embedded-wg-coc
Add code of conduct and update readme to reference
2 parents c3c0d3e + fe3f234 commit d691889

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
@@ -1,5 +1,4 @@
1-
rust-sysfs-pwm
2-
==============
1+
# rust-sysfs-pwm
32

43
[![Build Status](https://travis-ci.org/posborne/rust-sysfs-pwm.svg?branch=master)](https://travis-ci.org/posborne/rust-sysfs-pwm)
54
[![Version](https://img.shields.io/crates/v/sysfs-pwm.svg)](https://crates.io/crates/sysfs-pwm)
@@ -11,8 +10,7 @@ rust-sysfs-pwm is a rust library/crate providing access to the [Linux
1110
sysfs PWM interface](https://www.kernel.org/doc/Documentation/pwm.txt).
1211
It seeks to provide an API that is safe, convenient, and efficient.
1312

14-
Install/Use
15-
-----------
13+
## Install/Use
1614

1715
To use `sysfs-pwm`, first add this to your `Cargo.toml`:
1816

@@ -28,8 +26,7 @@ Then, add this to your crate root:
2826
extern crate sysfs_pwm;
2927
```
3028

31-
Example/API
32-
-----------
29+
## Example/API
3330

3431
The main API consists of a Pwm struct with the following methods:
3532
* `Pwm::new` - Create a Pwm instance
@@ -45,8 +42,7 @@ The main API consists of a Pwm struct with the following methods:
4542
Check out the [Breathing LED](examples/breathe.rs) example for a usage
4643
example.
4744

48-
Cross Compiling
49-
---------------
45+
## Cross Compiling
5046

5147
Most likely, the machine you are running on is not your development
5248
machine (although it could be). In those cases, you will need to
@@ -55,8 +51,7 @@ compiling for your platform.
5551

5652
[rust-cross]: https://github.com/japaric/rust-cross
5753

58-
Running the Example
59-
-------------------
54+
## Running the Example
6055

6156
Cross-compiling can be done by specifying an appropriate target. You
6257
can then move that to your device by whatever means and run it.
@@ -66,15 +61,27 @@ $ cargo build --target=arm-unknown-linux-gnueabihf --example breathe
6661
$ scp target/arm-unknown-linux-gnueabihf/debug/examples/breathe ...
6762
```
6863

69-
License
70-
-------
64+
## License
7165

72-
```
73-
Copyright (c) 2016, Paul Osborne <ospbau@gmail.com>
66+
Licensed under either of
7467

75-
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
76-
http://www.apache.org/license/LICENSE-2.0> or the MIT license
77-
<LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
78-
option. This file may not be copied, modified, or distributed
79-
except according to those terms.
80-
```
68+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
69+
http://www.apache.org/licenses/LICENSE-2.0)
70+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
71+
72+
at your option.
73+
74+
### Contribution
75+
76+
Unless you explicitly state otherwise, any contribution intentionally submitted
77+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
78+
dual licensed as above, without any additional terms or conditions.
79+
80+
## Code of Conduct
81+
82+
Contribution to this crate is organized under the terms of the [Rust Code of
83+
Conduct][CoC], the maintainer of this crate, the [Embedded Linux Team][team], promises
84+
to intervene to uphold that code of conduct.
85+
86+
[CoC]: CODE_OF_CONDUCT.md
87+
[team]: https://github.com/rust-embedded/wg#the-embedded-linux-team

0 commit comments

Comments
 (0)