Skip to content

Commit b6870d0

Browse files
orama254orama254
authored
chore: add code of conduct and contribution guidelines file (#38)
* refactor(readme): migrate contribution guidelines to guidelines file * chore: add code of conduct and contributing file to make the project contributor friendly adds the code of conduct and contribution guidelines as part of the GitHub standards for open source projects * fix: add code review suggestions adds an extra space after the contribution section of the readme to enforce consitency with the rest of the document.
1 parent 579a467 commit b6870d0

File tree

3 files changed

+167
-30
lines changed

3 files changed

+167
-30
lines changed

‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Contributing
2+
3+
Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.
4+
5+
Make sure your request is meaningful and you have tested the app locally before submitting a pull request.
6+
7+
### Installing dependencies
8+
9+
```bash
10+
# Dependencies for running the Flask server
11+
poetry install
12+
# Dependencies for testing and development
13+
poetry install --with dev
14+
# Dependencies for running the action script
15+
pip install feedparser
16+
```
17+
18+
### Running the Flask server
19+
20+
```bash
21+
gunicorn api.index:app
22+
```
23+
24+
### Running the action Python part of the workflow locally
25+
26+
```bash
27+
python action.py --channel_id=UCipSxT7a3rn81vGLw9lqRkg
28+
```
29+
30+
### Running tests
31+
32+
```bash
33+
tox
34+
```

‎README.md

+1-30
Original file line numberDiff line numberDiff line change
@@ -111,36 +111,7 @@ Contributions are welcome! Feel free to open an issue or submit a pull request i
111111

112112
Make sure your request is meaningful and you have tested the app locally before submitting a pull request.
113113

114-
### Installing dependencies
115-
116-
```bash
117-
# Dependencies for running the Flask server
118-
poetry install
119-
120-
# Dependencies for testing and development
121-
poetry install --with dev
122-
123-
# Dependencies for running the action script
124-
pip install feedparser
125-
```
126-
127-
### Running the Flask server
128-
129-
```bash
130-
gunicorn api.index:app
131-
```
132-
133-
### Running the action Python part of the workflow locally
134-
135-
```bash
136-
python action.py --channel_id=UCipSxT7a3rn81vGLw9lqRkg
137-
```
138-
139-
### Running tests
140-
141-
```bash
142-
tox
143-
```
114+
Please check out our [contributing guidelines](/CONTRIBUTING.md) for more information on how to contribute to this project.
144115

145116
## 🙋‍♂️ Support
146117

0 commit comments

Comments
 (0)