Skip to content

Commit fbbddfb

Browse files
authored
Merge pull request #83 from calibreapp/housekeeping-templates
Add Code of Conduct, Contributing guidelines and templates for issues + PRs
2 parents a2f8bb6 + 31849bb commit fbbddfb

6 files changed

Lines changed: 426 additions & 153 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Found an issue? File a bug report to help us improve React Live Chat Loader for everyone.
4+
title: "[Bug] Bug description"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
👋🏻 Hi there! This template will help you file a complete bug report for React Live Chat Loader, so one of the project maintainers can triage and respond to it promptly. Please fill relevant sections below and feel free to delete what does not apply to the issue you are seeing (including this comment).
11+
12+
Thank you for helping us improve React Live Chat Loader! ⚡️
13+
14+
***
15+
16+
## Describe the bug
17+
Please provide a clear and concise description of what the bug is. Include relevant operating system, browser and other environment information.
18+
19+
## How To Reproduce
20+
Steps to reproduce the behavior:
21+
22+
1. Go to '...'
23+
2. Click on '....'
24+
3. Scroll down to '....'
25+
4. See error
26+
27+
## Expected behaviour
28+
A clear and concise description of what you expected to happen.
29+
30+
## Screenshots
31+
If applicable, add screenshots to help explain the problem.
32+
33+
## Additional context
34+
Add any other context about the issue you’re seeing.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "\U0001F4A1 Feature Request"
3+
about: Have an idea how to make React Live Chat Loader better? We’re all ears!
4+
title: "[Feature Request] Feature description"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
👋🏻 Hi there! This template will help you file a complete feature request for React Live Chat Loader, so one of the project maintainers can triage and respond to it promptly. Please fill relevant sections below and feel free to delete what does not apply (including this comment).
11+
12+
Thank you for helping us improve React Live Chat Loader! ⚡️
13+
14+
## What problem would this feature solve?
15+
A clear and concise description of what the problem is. e.g. I'd love to use React Live Chat Loader with Live Chat Tool X!
16+
17+
## Describe the solution you’d like to see
18+
A clear and concise description of what you would like to happen. Are you willing to work on implementing this solution?
19+
20+
## Describe alternatives you’ve considered
21+
A clear and concise description of any alternative solutions or features you’ve considered.
22+
23+
## Additional context
24+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
👋🏻 Hi there!
2+
3+
This template will help you describe the work you’ve done, so one of the project maintainers can review and potentially accept it promptly. Please fill relevant sections below and feel free to delete what does not apply to your work (including this comment).
4+
5+
Thank you for helping us improve React Live Chat Loader! ⚡️
6+
7+
***
8+
9+
## What does this PR introduce?
10+
In a few bullet points, please describe the changes this Pull Request makes. e.g.:
11+
12+
- adds a new chat provider
13+
- fixes #
14+
- updates `README.md` with a better description for contributions
15+
16+
## Related issues
17+
Are there any related [issues or feature requests](https://github.com/calibreapp/react-live-chat-loader/issues) this work will resolve? Please mention them here. e.g.:
18+
19+
- closes #
20+
21+
Learn more about linking Pull Requests to issues [here](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue).
22+
23+
## Screenshots
24+
If this work introduces any visual changes, add screenshots to portray them.

CODE_OF_CONDUCT.md

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

0 commit comments

Comments
 (0)