Skip to content

Commit d2eb92d

Browse files
committed
Added CODE_OF_CONDUCT.md, PULL_REQUEST_TEMPLATE.md and ISSUE_TEMPLATE
1 parent ccd3a23 commit d2eb92d

File tree

6 files changed

+154
-0
lines changed

6 files changed

+154
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Code of Conduct
2+
3+
FastOpenAPI is built with one goal: to make life easier for developers working with different web frameworks.
4+
It's an open tool for open people.
5+
6+
## What We Expect
7+
8+
- Be respectful and constructive. We're all here to make things better.
9+
- Help others if you can. Ask for help if you need it.
10+
- Feedback is welcome — especially if it makes the tool easier to use.
11+
12+
## What We Don’t Accept
13+
14+
- Disrespectful or aggressive behavior
15+
- Personal attacks or gatekeeping
16+
- Any form of harassment
17+
18+
## Need to Talk?
19+
20+
If you run into a problem with another contributor or feel something’s off, you can open a **GitHub security advisory** or reach out privately via the repo contacts. We’ll handle it respectfully and discreetly.
21+
22+
---
23+
24+
Let’s keep FastOpenAPI useful, respectful, and open for everyone who wants to improve it.
25+
26+
---
File renamed without changes.
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve FastOpenAPI
3+
title: "[Bug] "
4+
labels: [bug]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug! Please fill out this form so we can better understand the issue.
12+
13+
- type: input
14+
id: environment
15+
attributes:
16+
label: Environment
17+
description: Describe your environment (Python version, OS, FastOpenAPI version, framework used, etc.)
18+
placeholder: Python 3.11, FastOpenAPI 0.5.0, Ubuntu 22.04, Flask 2.2
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Bug Description
26+
description: What happened and what did you expect to happen?
27+
placeholder: A clear and concise description of the problem.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: steps
33+
attributes:
34+
label: Steps to Reproduce
35+
description: How can we reproduce the bug?
36+
placeholder: |
37+
1. Go to '...'
38+
2. Use this code snippet '...'
39+
3. See the error message '...'
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: logs
45+
attributes:
46+
label: Logs or Tracebacks
47+
description: Paste relevant logs or tracebacks here.
48+
render: shell
49+
50+
- type: input
51+
id: contact
52+
attributes:
53+
label: Contact
54+
description: Optional – how can we reach you if we need more info?
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature] "
4+
labels: [enhancement]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Have an idea for FastOpenAPI? We'd love to hear it!
12+
13+
- type: input
14+
id: motivation
15+
attributes:
16+
label: What problem are you trying to solve?
17+
description: Explain the use case or need behind this feature.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: proposal
23+
attributes:
24+
label: Proposed Solution
25+
description: Describe the feature you’d like to see and how it might work.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Have you tried any alternative approaches or workarounds?
34+
35+
- type: input
36+
id: contact
37+
attributes:
38+
label: Contact
39+
description: Optional – how can we reach you if we need more info?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Pull Request
2+
3+
Thanks for contributing to FastOpenAPI!
4+
Before submitting, please make sure you've read [CONTRIBUTING.md](../CONTRIBUTING.md).
5+
6+
---
7+
8+
## What’s Included?
9+
10+
- [ ] New feature
11+
- [ ] Bug fix
12+
- [ ] Documentation improvement
13+
- [ ] Refactor / internal change
14+
15+
**Describe your changes:**
16+
17+
> Concise and clear: what did you change, why, and which parts/frameworks are affected?
18+
19+
---
20+
21+
## How Was It Tested?
22+
23+
> Describe how you tested the changes.
24+
> Were new tests added? Are examples working?
25+
26+
---
27+
28+
## Anything Else?
29+
30+
> Optional:
31+
> - Any TODOs or follow-up items?
32+
> - Known limitations or trade-offs?
33+
> - Anything you'd like reviewers to focus on?
34+
35+
---
File renamed without changes.

0 commit comments

Comments
 (0)