Skip to content

Commit

Permalink
Updated docs and added code of conduct.
Browse files Browse the repository at this point in the history
  • Loading branch information
speratus committed Sep 12, 2019
1 parent d4ffcee commit 514eb66
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 3 deletions.
69 changes: 69 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
This is the Blinkter Code of Conduct. By contributing to Blinkter either on Github or via Discord or
Gitter, you agree to abide by this code of conduct.

# A. Rules

1. You shall show respect to every member of whichever community you join.

Showing Respect includes but is not limited to:

a. You shall not insult any person for any reason.
b. You shall not use any kind of derogatory name or label for any member of the community.


2. You shall not use sexual language of any kind. This applies in the broadest possible sense: if something you are
considering posting *could be* construed as sexual language or a sexual reference, do not post it. Additionally, you
shall not post pictures of, videos of, or links to anything that is not safe for work (NSFW).

Violations of this rule may result in a permanent ban without prior notice or a warning of any kind.

3. Recognize that the ability to communicate with members of the community is granted to you as a privilege and
not a right. Do not abuse that privilege. In other words, do not advertise for anything, send spam, or engage in any
other activity which is outside the scope of the community.

# B. Reporting Violations

If you find that a member of the community has violated these rules, you may report such a violation by sending a
direct message to a moderator on either of the above mentioned platforms.

A violation report must include the following:

1. A description of the violation along with the username of the violator.
2. If possible, a screen shot of the offending message or comment. This will aid me in determining whether a violation
has occurred.

## i. Enforcement Process

If a violation is reported a moderator, the moderator will take the following steps:

1. He/she will take all reasonable steps to ascertain the veracity of the report.
2. He/she will notify the alleged violator that they have been reported for a violation of the rules. The alleged violator
is then free to defend their behavior. The moderator will take in to consideration the claims of the alleged violator
when assessing the veracity of the violation report.
3. Except where otherwise noted, if the report is found to be true, and this is a first time violation, the moderator
will issue a warning to the violator.

a. If the violator has received two warnings, the violator may be banned. The alleged violator will be issued no more
than three (3) warnings. Upon a fourth violation, the violator will be banned, and although a moderator may inform
the violator of my decision, moderators are under no obligation to do so.

4. If the the veracity of the report cannot be ascertained, the moderator will issue a warning to the violator informing
them that they have been reported for violating the rules.
5. If a member of the community repeatedly reports another member or members and the veracity of their reports cannot be
determined, then the reporting member will receive a warning that they are in violation of the rules. (In other words,
don't report someone because you don't like them. You will be banned for doing so.)

ALL ENFORCEMENT DECISIONS ARE AT THE DISCRETION OF THE MODERATORS OF THESE COMMUNITIES. ALL DECISIONS ARE FINAL AND
MODERATORS ARE NOT OBLIGATED TO EXPLAIN OR JUSTIFY THEIR DECISIONS TO THOSE FOUND IN VIOLATION OF THE RULES OR THOSE WHO
REPORT VIOLATIONS OF THE RULES.

IN MAKING ENFORCEMENT DECISIONS, MODERATORS WILL ENSURE THAT BOTH THE ALLEGED VIOLATOR AND THE VIOLATION REPORTER SHALL
RECEIVE FAIR CONSIDERATION BEFORE MAKING A DECISION.

# D. Scope
This code of conduct applies to all contributors on Github, Discord server members, and Gitter community
members.

For the purposes of this document, a contributor is someone who adds text, source code, images, links,
to any part of the Github repository. This includes, but is not limited to, the Wiki, Issues, and pull
requests.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[![GitHub issues](https://img.shields.io/github/issues/speratus/Blinkter.svg)](https://github.com/speratus/Blinkter/issues)
[![GitHub forks](https://img.shields.io/github/forks/speratus/Blinkter.svg)](https://github.com/speratus/Blinkter/network)

[![Gitter](https://badges.gitter.im/raspberrypi-blinkter/community.svg)](https://gitter.im/raspberrypi-blinkter/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Discord](https://img.shields.io/discord/610943654806159453)](https://discord.gg/YqRfXwJ)

Blinkter makes using the [Pimoroni Blinkt!](https://shop.pimoroni.com/products/blinkt) even easier by making the library object oriented and
adding several convenience methods. The intuitive objects that Blinkter layers on top of the [Blinkt!](https://github.com/pimoroni/blinkt)
Expand Down Expand Up @@ -62,6 +64,11 @@ board = blinkter.BlinktBoard()
pixel = board.get_pixel(0) #Or whatever pixel you want to manipulate
pixel.red() #Or pixel.blue(), or whatever else you want.
```

# Contact

You can ask questions on the

# Links
* [Pimoroni Blinkt! product page](https://shop.pimoroni.com/products/blinkt)
* [Blinkt library](https://github.com/pimoroni/blinkt)
Expand Down
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,12 @@ Contents
.. toctree::
:maxdepth: 2

classes/BlinktBoard
classes/Pixel
classes/LED
api
contact
version
issues





Expand Down

0 comments on commit 514eb66

Please sign in to comment.