Skip to content

Commit 000407d

Browse files
committed
Add CONTRIBUTING.md
1 parent 60f59f8 commit 000407d

File tree

2 files changed

+156
-0
lines changed

2 files changed

+156
-0
lines changed

Diff for: CONTRIBUTING.md

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# Contributing
2+
3+
We use fairly "standard" github contribution workflow:
4+
5+
1. Make an [Issue](https://github.com/3d-group/unity-simple-notifications/issues/new)
6+
2. Fork this repository (For further details, see https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
7+
3. Develop changes to a new branch to your forked repository
8+
4. Create a Pull Request from your forked repository against this repository
9+
1. Insert a reference in the description to the issue created earlier eg. "Closes #1" where "1" is the issue number
10+
2. Pull request description should answer these questions: "What has been changed" and "What is this for"
11+
12+
Please note we have a code of conduct, please follow it in all your interactions with the project :smile:
13+
14+
## Developing
15+
16+
One way to develop this Unity package is to create a new Unity Project and copy this package to its Assets folder.
17+
18+
This way .meta files (required by Unity) are generated automatically. Assets available in the package can now be tested and developed inside the project.
19+
20+
For further details, see [Unity docs about custom packages](https://docs.unity3d.com/Manual/CustomPackages.html).
21+
22+
# Code of Conduct
23+
24+
## Our Pledge
25+
26+
We as members, contributors, and leaders pledge to make participation in our
27+
community a harassment-free experience for everyone, regardless of age, body
28+
size, visible or invisible disability, ethnicity, sex characteristics, gender
29+
identity and expression, level of experience, education, socio-economic status,
30+
nationality, personal appearance, race, religion, or sexual identity
31+
and orientation.
32+
33+
We pledge to act and interact in ways that contribute to an open, welcoming,
34+
diverse, inclusive, and healthy community.
35+
36+
## Our Standards
37+
38+
Examples of behavior that contributes to a positive environment for our
39+
community include:
40+
41+
* Demonstrating empathy and kindness toward other people
42+
* Being respectful of differing opinions, viewpoints, and experiences
43+
* Giving and gracefully accepting constructive feedback
44+
* Accepting responsibility and apologizing to those affected by our mistakes,
45+
and learning from the experience
46+
* Focusing on what is best not just for us as individuals, but for the
47+
overall community
48+
49+
Examples of unacceptable behavior include:
50+
51+
* The use of sexualized language or imagery, and sexual attention or
52+
advances of any kind
53+
* Trolling, insulting or derogatory comments, and personal or political attacks
54+
* Public or private harassment
55+
* Publishing others' private information, such as a physical or email
56+
address, without their explicit permission
57+
* Other conduct which could reasonably be considered inappropriate in a
58+
professional setting
59+
60+
## Enforcement Responsibilities
61+
62+
Community leaders are responsible for clarifying and enforcing our standards of
63+
acceptable behavior and will take appropriate and fair corrective action in
64+
response to any behavior that they deem inappropriate, threatening, offensive,
65+
or harmful.
66+
67+
Community leaders have the right and responsibility to remove, edit, or reject
68+
comments, commits, code, wiki edits, issues, and other contributions that are
69+
not aligned to this Code of Conduct, and will communicate reasons for moderation
70+
decisions when appropriate.
71+
72+
## Scope
73+
74+
This Code of Conduct applies within all community spaces, and also applies when
75+
an individual is officially representing the community in public spaces.
76+
Examples of representing our community include using an official e-mail address,
77+
posting via an official social media account, or acting as an appointed
78+
representative at an online or offline event.
79+
80+
## Enforcement
81+
82+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
83+
reported to the community leaders responsible for enforcement at
84+
[[email protected]](mailto:[email protected]?subject=OS Community Report).
85+
All complaints will be reviewed and investigated promptly and fairly.
86+
87+
All community leaders are obligated to respect the privacy and security of the
88+
reporter of any incident.
89+
90+
## Enforcement Guidelines
91+
92+
Community leaders will follow these Community Impact Guidelines in determining
93+
the consequences for any action they deem in violation of this Code of Conduct:
94+
95+
### 1. Correction
96+
97+
**Community Impact**: Use of inappropriate language or other behavior deemed
98+
unprofessional or unwelcome in the community.
99+
100+
**Consequence**: A private, written warning from community leaders, providing
101+
clarity around the nature of the violation and an explanation of why the
102+
behavior was inappropriate. A public apology may be requested.
103+
104+
### 2. Warning
105+
106+
**Community Impact**: A violation through a single incident or series
107+
of actions.
108+
109+
**Consequence**: A warning with consequences for continued behavior. No
110+
interaction with the people involved, including unsolicited interaction with
111+
those enforcing the Code of Conduct, for a specified period of time. This
112+
includes avoiding interactions in community spaces as well as external channels
113+
like social media. Violating these terms may lead to a temporary or
114+
permanent ban.
115+
116+
### 3. Temporary Ban
117+
118+
**Community Impact**: A serious violation of community standards, including
119+
sustained inappropriate behavior.
120+
121+
**Consequence**: A temporary ban from any sort of interaction or public
122+
communication with the community for a specified period of time. No public or
123+
private interaction with the people involved, including unsolicited interaction
124+
with those enforcing the Code of Conduct, is allowed during this period.
125+
Violating these terms may lead to a permanent ban.
126+
127+
### 4. Permanent Ban
128+
129+
**Community Impact**: Demonstrating a pattern of violation of community
130+
standards, including sustained inappropriate behavior, harassment of an
131+
individual, or aggression toward or disparagement of classes of individuals.
132+
133+
**Consequence**: A permanent ban from any sort of public interaction within
134+
the community.
135+
136+
## Attribution
137+
138+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
139+
version 2.0, available at
140+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
141+
142+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
143+
enforcement ladder](https://github.com/mozilla/diversity).
144+
145+
[homepage]: https://www.contributor-covenant.org
146+
147+
For answers to common questions about this code of conduct, see the FAQ at
148+
https://www.contributor-covenant.org/faq. Translations are available at
149+
https://www.contributor-covenant.org/translations.

Diff for: CONTRIBUTING.md.meta

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)