Skip to content

Commit 428c8fe

Browse files
+ basic stuff
0 parents  commit 428c8fe

17 files changed

+652
-0
lines changed

.github/CODEOWNERS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @caffeine-addictt

.github/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, religion, or sexual identity
10+
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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of 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
35+
address, 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+
junxiangng63@gmail.com.
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
86+
of 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
93+
permanent 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
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# **Contributing**
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface; this includes new environment variables, exposed ports, valid file locations and container parameters.
13+
3. Increase the version numbers in any examples files and the README.md to the new version that this
14+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
15+
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
16+
do not have permission to do that, you may request the second reviewer to merge it for you.
17+
18+
## Issue Report Process
19+
20+
1. Go to the project's issues.
21+
2. Select the template that better fits your issue.
22+
3. Read the instructions carefully and write within the template guidelines.
23+
4. Submit it and wait for support.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: "Bug Report"
3+
about: "Report an issue to help the project improve."
4+
title: "[Bug] "
5+
labels: "Type: Bug"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Bug report
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
13+
14+
## Expected Behavior
15+
<!--
16+
If you're describing a bug, tell us what should happen
17+
If you're suggesting a change/improvement, tell us how it should work
18+
19+
Please include screenshots and/or code snippets if applicable
20+
-->
21+
22+
## Current Behavior
23+
<!--
24+
If describing a bug, tell us what happens instead of the expected behavior
25+
If suggesting a change/improvement, explain the difference from current behavior
26+
27+
Please include screenshots and/or code snippets if applicable
28+
-->
29+
30+
## Is this a regression?
31+
<!--
32+
Did this behaviour use to work in previous versions?
33+
If yes, what is the latest version where this behaviour is not present?
34+
-->
35+
36+
## Possible Solution
37+
<!--
38+
Not obligatory, but suggest a fix/reason for the bug
39+
or ideas how to implement the addition or change
40+
-->
41+
42+
## Steps to Reproduce (for bugs)
43+
<!--
44+
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
45+
-->
46+
1.
47+
2.
48+
3.
49+
4.
50+
51+
## Context
52+
<!--
53+
How has this issue affected you?
54+
What are you trying to accomplish?
55+
56+
Providing context helps us come up with a solution that is most useful in the real world.
57+
58+
Please include screenshots and/or code snippets if applicable
59+
-->
60+
61+
## Your Environment
62+
<!--
63+
Include as many relevant details about the environment you experienced the bug in
64+
-->
65+
* Version used:
66+
* Browser Name and version:
67+
* Operating System and version (desktop or mobile):
68+
* Link to your project:
69+
* Node version:
70+
* Python version:
71+
* Tailwind CLI version:
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: "Failing Test"
3+
about: "Report failing tests or CI jobs."
4+
title: "[Test] "
5+
labels: "Type: Test"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Failing Test
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
13+
14+
## Which Jobs/Tests are Failing?
15+
*
16+
17+
## Reason for Failure
18+
<!--
19+
Why is/are this/these job/test(s) failing?
20+
What are we missing to make it pass?
21+
-->
22+
23+
## Media Prove
24+
<!--
25+
If applicable, add screenshots or code snippets to explain the issue
26+
If not applicable, remove this field
27+
-->
28+
29+
## Additional Context
30+
<!--
31+
Any other extra context or information
32+
-->
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Documentation or README.md issue report"
3+
about: "Report an issue in the project's documentation or README.md file."
4+
title: ""
5+
labels: "Documentation"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Documentation Issue Report
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
13+
14+
## Describe the Bug
15+
<!--
16+
A clear and concise description of the bug
17+
-->
18+
19+
## Steps to Reproduce
20+
<!--
21+
e.g.:
22+
1. Navigate to docs/x
23+
2. Go to...
24+
3. See error
25+
-->
26+
27+
1.
28+
2.
29+
3.
30+
4.
31+
32+
## Additional Context
33+
<!--
34+
Any other extra context or information
35+
-->
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Feature Request"
3+
about: "Suggest an idea or possible new feature for this project."
4+
title: ""
5+
labels: "Type: Feature"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Feature Request
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
13+
14+
## Is Your Feature Request Related to an Issue?
15+
<!--
16+
If yes, provide a clear and concise description of what the problem is
17+
E.g.:
18+
Issue #
19+
I'm always frustrated when...
20+
-->
21+
22+
## Describe the Solution You'd Like
23+
<!--
24+
A clear and concise description of what you'd like
25+
-->
26+
27+
## Describe Alternatives You've Considered
28+
<!--
29+
A clear and concise description of other alternatives you have considered
30+
-->
31+
32+
## Additional Context
33+
<!--
34+
Any other extra context or information
35+
-->
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Enhancement Request"
3+
about: "Suggest an enhancement for this project. Improve an existing feature"
4+
title: ""
5+
labels: "Type: Enhancement"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Enhancement Request
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
13+
14+
## Is Your Enhancement Request Related to an Issue?
15+
<!--
16+
If yes, provide a clear and concise description of what the problem is
17+
E.g.:
18+
Issue #
19+
I'm always frustrated when...
20+
-->
21+
22+
## Describe the Solution You'd Like
23+
<!--
24+
A clear and concise description of what you'd like
25+
-->
26+
27+
## Describe Alternatives You've Considered
28+
<!--
29+
A clear and concise description of other alternatives you have considered
30+
-->
31+
32+
## Additional Context
33+
<!--
34+
Any other extra context or information
35+
-->

0 commit comments

Comments
 (0)