Skip to content

Commit 05844f8

Browse files
committed
Update CONTRIBUTING.md
Also add code of conduct.
1 parent 7aff32c commit 05844f8

File tree

2 files changed

+100
-12
lines changed

2 files changed

+100
-12
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,29 @@ ports, so you can listen in on the traffic players and mixers send
3030
between themselves. The [Netgear GS105Ev2][switch] has worked great
3131
for us.
3232

33+
> [!IMPORTANT]
34+
> Before doing any significant work, we strongly encourage you to discuss your ideas in the [Zulip channel][zulip].
35+
> This will help make sure you’re on the right track, could save you a lot of effort, and ensure alignment with the overall project philosophy and goals.
36+
37+
### Code from AI / LLM Tools
38+
39+
If you are planning to contribute code, please refrain from copy and pasting it from “AI” code assistants and large language models.
40+
It is fine to use those as an inspiration, or examples of the ways something could be done, but always write your own code from scratch if you are going to submit it to the project.
41+
42+
> [!WARNING]
43+
> Code from online coding assistants may be plagiarized from other projects with incompatible licenses (and there is no way to know), and may include subtle bugs.
44+
> It is not suitable for submission to Deep Symmetry projects.
45+
3346
## Giving back
3447

3548
The most informal and fun way to get involved in the project is to
3649
introduce yourself and start chatting on the [Zulip
37-
stream](https://deep-symmetry.zulipchat.com/#narrow/stream/275855-dysentery-.26-crate-digger).
50+
channel][zulip].
3851

3952
Once you have something working you’d like to share, you can open a
4053
[pull request][pulls].
4154

42-
Or if you simply have an idea, or something that you wish worked
43-
differently, feel free to open an [issue][issues] if it seems like
44-
nobody already has.
45-
55+
Or if you simply have an idea, or something that you wish worked differently, feel free to discuss it in the [Zulip channel][zulip], and if directed to do so by the community there, open an [issue][issues].
4656
## Maintainers
4757

4858
Crate Digger is primarily maintained by [@brunchboy][brunchboy].
@@ -51,7 +61,7 @@ Crate Digger is primarily maintained by [@brunchboy][brunchboy].
5161

5262
<a href="http://deepsymmetry.org"><img src="doc/assets/DS-logo-github.png"
5363
align="right" alt="Deep Symmetry logo" width="250" height="150"></a>
54-
Copyright © 2018–2022 [Deep Symmetry, LLC](http://deepsymmetry.org)
64+
Copyright © 2018–2022 [Deep Symmetry, LLC][deep-symmetry]
5565

5666
Distributed under the [Eclipse Public License
5767
2.0](https://opensource.org/licenses/EPL-2.0). By using this software
@@ -66,12 +76,14 @@ satisfied: [Mozilla Public License
6676
2.0](https://www.mozilla.org/en-US/MPL/2.0/), or [GNU Lesser General
6777
Public License v. 3](https://opensource.org/licenses/LGPL-3.0).
6878

79+
[brunchboy]: https://github.com/brunchboy
6980
[contributions-released]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
70-
[covenant]: http://contributor-covenant.org/
71-
[maven]: https://maven.apache.org
72-
[idea]: https://www.jetbrains.com/idea/
81+
[covenant]: https://contributor-covenant.org/
82+
[deep-symmetry]: https://deepsymmetry.org
7383
[emacs]: https://www.gnu.org/software/emacs/
74-
[switch]: https://smile.amazon.com/gp/product/B00HGLVZLY/
75-
[pulls]: https://github.com/Deep-Symmetry/crate-digger/pulls
84+
[idea]: https://www.jetbrains.com/idea/
7685
[issues]: https://github.com/Deep-Symmetry/crate-digger/issues
77-
[brunchboy]: https://github.com/brunchboy
86+
[maven]: https://maven.apache.org
87+
[pulls]: https://github.com/Deep-Symmetry/crate-digger/pulls
88+
[switch]: https://smile.amazon.com/gp/product/B00HGLVZLY/
89+
[zulip]: https://deep-symmetry.zulipchat.com/#narrow/stream/275855-dysentery-.26-crate-digger

0 commit comments

Comments
 (0)