Skip to content

Commit 660d73d

Browse files
committed
add PR template and CoC
1 parent 63cf323 commit 660d73d

File tree

2 files changed

+121
-0
lines changed

2 files changed

+121
-0
lines changed

.github/pull_request_template.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Related Issues
2+
3+
- fixes #issue-number
4+
5+
### Proposed Changes:
6+
7+
<!--- In case of a bug: Describe what caused the issue and how you solved it -->
8+
<!--- In case of a feature: Describe what did you add and how it works -->
9+
10+
### How did you test it?
11+
12+
<!-- unit tests, integration tests, manual verification, instructions for manual tests -->
13+
14+
### Notes for the reviewer
15+
16+
<!-- E.g. point out section where the reviewer -->
17+
18+
### Checklist
19+
20+
- I have read the [contributors guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/deepset-ai/haystack-core-integrations/blob/main/code_of_conduct.txt)
21+
- I have updated the related issue with new insights and changes
22+
- I added unit tests and updated the docstrings
23+
- I've used one of the [conventional commit types](https://www.conventionalcommits.org/en/v1.0.0/) for my PR title: `fix:`, `feat:`, `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`.

code_of_conduct.txt

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

0 commit comments

Comments
 (0)