Skip to content

Commit 82a20e6

Browse files
Tomas-PytelTomas-Pytel
authored andcommitted
Update README.md
Add CODE_OF_CONDUCT.md Add CONTRIBUTING.md
1 parent 97f8588 commit 82a20e6

3 files changed

Lines changed: 103 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project owner (or team) at [pytlicek@gmail.com][email]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
[email]: mailto:pytlicek@gmail.com
75+
76+
For answers to common questions about this code of conduct, see
77+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Contributing to fastapi-featureflags
2+
======================
3+
4+
As an open source project, fastapi-featureflags welcomes contributions of many forms.
5+
6+
Examples of contributions include:
7+
* New features / improvements
8+
* Code patches
9+
* Documentation improvements
10+
* Bug reports and patch reviews
11+
12+
13+
Code of Conduct
14+
===============
15+
16+
As a contributor, you can help us keep the fastapi-featureflags project open and inclusive.
17+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md)

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,15 @@ app.include_router(ff_router, tags=["FeatureFlags"])
6868
---
6969
<img width="100%" alt="FastAPI-FF" src="https://user-images.githubusercontent.com/1430522/144305907-5e231e64-c120-4bde-9aad-58b9b194a361.png">
7070

71+
# Contributing and Code of Conduct
72+
### Contributing to fastapi-featureflags
73+
As an open source project, fastapi-featureflags welcomes contributions of many forms.
74+
Please read and follow our [Contributing to fastapi-featureflags](CONTRIBUTING.md)
75+
76+
### Code of Conduct
77+
As a contributor, you can help us keep the fastapi-featureflags project open and inclusive.
78+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md)
79+
7180
---
7281
### TODO
7382
- Better main class

0 commit comments

Comments
 (0)