Skip to content

Commit ef40c0e

Browse files
feat: add community health files (#21)
* feat: add COC * feat: add contributing md
1 parent 11eb8f2 commit ef40c0e

File tree

2 files changed

+201
-0
lines changed

2 files changed

+201
-0
lines changed

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!-- omit in toc -->
2+
3+
# Contributing to nuxt-websocket
4+
5+
First off, thanks for taking the time to contribute! ❤️
6+
7+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them.
8+
9+
<!-- omit in toc -->
10+
11+
## Table of Contents
12+
13+
- [I Have a Question](#i-have-a-question)
14+
- [I Want To Contribute](#i-want-to-contribute)
15+
- [Pull Request process](#pull-request-process)
16+
- [Reporting Bugs](#reporting-bugs)
17+
- [Suggesting Enhancements](#suggesting-enhancements)
18+
19+
## I Have a Question
20+
21+
Before you ask a question, it is best to search for existing [Issues](https://github.com/deepsourcelabs/nuxt-websocket/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
22+
23+
If you then still feel the need to ask a question and need clarification, we recommend the following:
24+
25+
- Open an [Issue](https://github.com/deepsourcelabs/nuxt-websocket/issues/new/choose).
26+
- The issue template form should guide you to ensure you cover all the information required for the maintainers to find the relevant issue
27+
28+
We will then take care of the issue as soon as possible.
29+
30+
## I Want To Contribute
31+
32+
> ### Legal Notice <!-- omit in toc -->
33+
>
34+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
35+
36+
### Reporting Bugs
37+
38+
<!-- omit in toc -->
39+
40+
#### Before Submitting a Bug Report
41+
42+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
43+
44+
- Make sure that you are using the latest version.
45+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/deepsourcelabs/nuxt-websocket#setup). If you are looking for support, you might want to check [this section](#i-have-a-question)).
46+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/deepsourcelabs/nuxt-websocket/issues?q=label%3Abug).
47+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
48+
49+
### Suggesting Enhancements
50+
51+
This section guides you through submitting an enhancement suggestion for nuxt-websocket, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
52+
53+
<!-- omit in toc -->
54+
55+
#### Before Submitting an Enhancement
56+
57+
- Make sure that you are using the latest version.
58+
- Read the [documentation](https://github.com/deepsourcelabs/nuxt-websocket#setup) carefully and find out if the functionality is already covered, maybe by an individual configuration.
59+
- Perform a [search](https://github.com/deepsourcelabs/nuxt-websocket/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
60+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature.
61+
62+
## Pull Request Process
63+
64+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
65+
build.
66+
2. Update the README.md with details of changes to the interface, this includes new environment
67+
variables, exposed ports, useful file locations and container parameters.
68+
3. Increase the version numbers in any examples files and the README.md to the new version that this
69+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
70+
4. Your pull request will be merged once it is signed-off by a maintainer.

0 commit comments

Comments
 (0)