Skip to content

Commit dd74e2f

Browse files
CDariusCDarius
committed
Prepared the library to be shared in the bundle and added sphinx documentation
1 parent ba8cf73 commit dd74e2f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+2543
-749
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
3+
SPDX-FileCopyrightText: 2019-2021 Kattni Rembor
4+
5+
SPDX-License-Identifier: CC-BY-4.0
6+
-->
7+
# CircuitPython Community Code of Conduct
8+
9+
## Our Pledge
10+
11+
In the interest of fostering an open and welcoming environment, we as
12+
contributors and leaders pledge to making participation in our project and
13+
our community a harassment-free experience for everyone, regardless of age, body
14+
size, disability, ethnicity, gender identity and expression, level or type of
15+
experience, education, socio-economic status, nationality, personal appearance,
16+
race, religion, or sexual identity and orientation.
17+
18+
## Our Standards
19+
20+
We are committed to providing a friendly, safe and welcoming environment for
21+
all.
22+
23+
Examples of behavior that contributes to creating and maintaining a positive environment
24+
include:
25+
26+
* Be kind and courteous to others
27+
* Using welcoming and inclusive language
28+
* Respecting the identity of every community member, including asking for their
29+
pronouns if uncertain
30+
* Being respectful of differing viewpoints and experiences
31+
* Collaborating with other community members
32+
* Providing desired assistance and knowledge to other community members
33+
* Being open to new information and ideas
34+
* Gracefully accepting constructive criticism
35+
* Focusing on what is best for the community
36+
* Showing empathy towards other community members
37+
38+
Examples of unacceptable behavior by community members include:
39+
40+
* The use of sexualized language or imagery and sexual attention or advances
41+
* The use of inappropriate images, including in a community member's avatar
42+
* The use of inappropriate language or profanity, including in a community member's nickname
43+
* Any spamming, flaming, baiting or other attention-stealing behavior
44+
* Excessive or unwelcome helping; answering outside the scope of the question
45+
asked
46+
* Discussion or promotion of activities or projects that intend or pose a risk of
47+
significant harm
48+
* Trolling, insulting/derogatory comments, and attacks of any nature (including,
49+
but not limited to, personal or political attacks)
50+
* Promoting or spreading disinformation, lies, or conspiracy theories against
51+
a person, group, organisation, project, or community
52+
* Public or private harassment
53+
* Publishing others' private information, such as a physical or electronic
54+
address, without explicit permission
55+
* Engaging in behavior that creates an unwelcoming or uninclusive environment
56+
* Other conduct which could reasonably be considered inappropriate
57+
58+
The CircuitPython Community welcomes everyone and strives to create a safe space for all. It is built
59+
around sharing and contributing to technology. We encourage discussing your thoughts, experiences,
60+
and feelings within the scope of the community. However, there are topics that can sometimes stray
61+
from that scope, and can lead to hurting others and create an unwelcoming, uninclusive environment.
62+
63+
Examples of discussion topics that have been known to stray outside the scope of the CircuitPython
64+
Community include, but are not limited to:
65+
66+
* Discussions regarding religion and related topics
67+
* Discussions regarding politics and related topics
68+
69+
The goal of the standards and moderation guidelines outlined here is to build
70+
and maintain a respectful community. We ask that you don’t just aim to be
71+
"technically unimpeachable", but rather try to be your best self.
72+
73+
We value many things beyond technical expertise, including collaboration and
74+
supporting others within our community. Providing a positive experience for
75+
other community members can have a much more significant impact than simply
76+
providing the correct answer.
77+
78+
## Our Responsibilities
79+
80+
Project leaders are responsible for clarifying the standards of acceptable
81+
behavior and are expected to take appropriate and fair corrective action in
82+
response to any instances of unacceptable behavior.
83+
84+
Project leaders have the right and responsibility to remove, edit, or
85+
reject messages, comments, commits, code, issues, and other contributions
86+
that are not aligned to this Code of Conduct, or to ban temporarily or
87+
permanently any community member for other behaviors that they deem
88+
inappropriate, threatening, offensive, or harmful.
89+
90+
## Moderation
91+
92+
Instances of behaviors that violate the CircuitPython Community Code of Conduct
93+
may be reported by any member of the community. Community members are
94+
encouraged to report these situations, including situations they witness
95+
involving other community members.
96+
97+
You may report in the following ways:
98+
99+
In any situation, you may email the project maintainer.
100+
101+
The source of email and direct message reports will be kept confidential.
102+
103+
In situations on GitHub where the issue is particularly offensive, possibly
104+
illegal, requires immediate action, or violates the GitHub terms of service,
105+
you should also report the message directly to GitHub via the comment, or via
106+
[GitHub Support](https://support.github.com/contact/report-abuse?category=report-abuse&report=other&report_type=unspecified).
107+
108+
These are the steps for upholding our community’s standards of conduct.
109+
110+
1. Any member of the community may report any situation that violates the
111+
CircuitPython Community Code of Conduct. All reports will be reviewed and
112+
investigated.
113+
2. If the behavior is a severe violation, the community member who
114+
committed the violation may be banned immediately, without warning.
115+
3. Otherwise, moderators will first respond to such behavior with a warning.
116+
4. Moderators follow a soft "three strikes" policy - the community member may
117+
be given another chance, if they are receptive to the warning and change their
118+
behavior.
119+
5. If the community member is unreceptive or unreasonable when warned by a
120+
moderator, or the warning goes unheeded, they may be banned for a first or
121+
second offense. Repeated offenses will result in the community member being
122+
banned.
123+
6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply
124+
to the platform where the violation occurred. However, depending on the severity
125+
of the violation, the disciplinary action may be applied across CircuitPython's
126+
other community platforms. For example, a severe violation in one Community forum
127+
may result in a ban on not only the CircuitPython GitHub organisation,
128+
but also on the CircuitPython Twitter, live stream text chats, etc.
129+
130+
## Scope
131+
132+
This Code of Conduct and the enforcement policies listed above apply to all
133+
CircuitPython Community venues. This includes but is not limited to any community
134+
spaces (both public and private), and CircuitPython GitHub repositories. Examples of
135+
CircuitPython Community spaces include but are not limited to meet-ups, issue
136+
threads on GitHub, text chats during a live stream, or interaction at a conference.
137+
138+
This Code of Conduct applies both within project spaces and in public spaces
139+
when an individual is representing the project or its community. As a community
140+
member, you are representing our community, and are expected to behave
141+
accordingly.
142+
143+
## Attribution
144+
145+
This Code of Conduct is adapted from the
146+
[Adafruit Community Code of Conduct](https://github.com/adafruit/Adafruit_Community_Code_of_Conduct),
147+
which is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
148+
version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
149+
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
150+
151+
For other projects adopting the CircuitPython Community Code of
152+
Conduct, please contact the maintainers of those projects for enforcement.
153+
If you wish to use this code of conduct for your own project, consider
154+
explicitly mentioning your moderation policy or making a copy with your
155+
own moderation policy so as to avoid confusion.

‎LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
MIT License
1+
The MIT License (MIT)
22

3-
Copyright (c) 2024 CDarius
3+
Copyright (c) 2024 Dario Cammi
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)