Skip to content

Commit 020d0cb

Browse files
patrick91patrick91
committed
first commit
0 parents  commit 020d0cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+3632
-0
lines changed

‎.github/DISCUSSION_TEMPLATE/questions.yml‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
labels: [question]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Thanks for your interest in this project! 🚀
7+
8+
Please follow these instructions, fill every question, and do every step. 🙏
9+
10+
I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
11+
12+
I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling questions.
13+
14+
All that, on top of all the incredible help provided by a bunch of community members, that give a lot of their time to come here and help others.
15+
16+
That's a lot of work, but if more users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).
17+
18+
By asking questions in a structured way (following this) it will be much easier to help you.
19+
20+
And there's a high chance that you will find the solution along the way and you won't even have to submit it and wait for an answer. 😎
21+
22+
As there are too many questions, I'll have to discard and close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
23+
- type: checkboxes
24+
id: checks
25+
attributes:
26+
label: First Check
27+
description: Please confirm and check all the following options.
28+
options:
29+
- label: I added a very descriptive title here.
30+
required: true
31+
- label: I used the GitHub search to find a similar question and didn't find it.
32+
required: true
33+
- label: I searched in the documentation/README.
34+
required: true
35+
- label: I already searched in Google "How to do X" and didn't find any information.
36+
required: true
37+
- label: I already read and followed all the tutorial in the docs/README and didn't find an answer.
38+
required: true
39+
- type: checkboxes
40+
id: help
41+
attributes:
42+
label: Commit to Help
43+
description: |
44+
After submitting this, I commit to one of:
45+
46+
* Read open questions until I find 2 where I can help someone and add a comment to help there.
47+
* I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
48+
49+
options:
50+
- label: I commit to help with one of those options 👆
51+
required: true
52+
- type: textarea
53+
id: example
54+
attributes:
55+
label: Example Code
56+
description: |
57+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
58+
59+
If I (or someone) can copy it, run it, and see it right away, there's a much higher chance I (or someone) will be able to help you.
60+
61+
placeholder: |
62+
Write your example code here.
63+
render: Text
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: description
68+
attributes:
69+
label: Description
70+
description: |
71+
What is the problem, question, or error?
72+
73+
Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
74+
placeholder: |
75+
* Create a Django app.
76+
* Run `fastapi dev`.
77+
* I expected it to run the Django app, but it didn't.
78+
validations:
79+
required: true
80+
- type: dropdown
81+
id: os
82+
attributes:
83+
label: Operating System
84+
description: What operating system are you on?
85+
multiple: true
86+
options:
87+
- Linux
88+
- Windows
89+
- macOS
90+
- Other
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: os-details
95+
attributes:
96+
label: Operating System Details
97+
description: You can add more details about your operating system here, in particular if you chose "Other".
98+
validations:
99+
required: true
100+
- type: input
101+
id: python-version
102+
attributes:
103+
label: Python Version
104+
description: |
105+
What Python version are you using?
106+
107+
You can find the Python version with:
108+
109+
```bash
110+
python --version
111+
```
112+
validations:
113+
required: true
114+
- type: textarea
115+
id: context
116+
attributes:
117+
label: Additional Context
118+
description: Add any additional context information or screenshots you think are useful.

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [tiangolo]

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Contact
4+
about: Please report security vulnerabilities to [email protected]
5+
- name: Question or Problem
6+
about: Ask a question or ask about a problem in GitHub Discussions.
7+
url: https://github.com/fastapi/fastapi-cli/discussions/categories/questions
8+
- name: Feature Request
9+
about: To suggest an idea or ask about a feature, please start with a question saying what you would like to achieve. There might be a way to do it already.
10+
url: https://github.com/fastapi/fastapi-cli/discussions/categories/questions

‎.github/ISSUE_TEMPLATE/privileged.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Privileged
2+
description: You are @tiangolo or he asked you directly to create an issue here. If not, check the other options. 👇
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thanks for your interest in this project! 🚀
8+
9+
If you are not @tiangolo or he didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/tiangolo/fastapi-cli/discussions/categories/questions) instead.
10+
- type: checkboxes
11+
id: privileged
12+
attributes:
13+
label: Privileged issue
14+
description: Confirm that you are allowed to create an issue here.
15+
options:
16+
- label: I'm @tiangolo or he asked me directly to create an issue here.
17+
required: true
18+
- type: textarea
19+
id: content
20+
attributes:
21+
label: Issue Content
22+
description: Add the content of the issue here.

‎.github/dependabot.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 2
2+
updates:
3+
# GitHub Actions
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "daily"
8+
commit-message:
9+
prefix: ⬆
10+
# Python
11+
- package-ecosystem: "pip"
12+
directory: "/"
13+
schedule:
14+
interval: "daily"
15+
commit-message:
16+
prefix: ⬆

‎.github/labeler.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
docs:
2+
- all:
3+
- changed-files:
4+
- any-glob-to-any-file:
5+
- README.md
6+
- all-globs-to-all-files:
7+
- '!src/**'
8+
- '!pyproject.toml'
9+
10+
internal:
11+
- all:
12+
- changed-files:
13+
- any-glob-to-any-file:
14+
- .github/**
15+
- scripts/**
16+
- .gitignore
17+
- .pre-commit-config.yaml
18+
- pdm_build.py
19+
- requirements*.txt
20+
- all-globs-to-all-files:
21+
- README.md
22+
- '!src/**'
23+
- '!pyproject.toml'

‎.github/workflows/add-to-project.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Add to Project
2+
3+
on:
4+
pull_request_target:
5+
issues:
6+
types:
7+
- opened
8+
- reopened
9+
10+
jobs:
11+
add-to-project:
12+
name: Add to project
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/[email protected]
16+
with:
17+
project-url: https://github.com/orgs/fastapi/projects/2
18+
github-token: ${{ secrets.PROJECTS_TOKEN }}

‎.github/workflows/issue-manager.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Issue Manager
2+
3+
on:
4+
schedule:
5+
- cron: "13 19 * * *"
6+
issue_comment:
7+
types:
8+
- created
9+
issues:
10+
types:
11+
- labeled
12+
pull_request_target:
13+
types:
14+
- labeled
15+
workflow_dispatch:
16+
17+
permissions:
18+
issues: write
19+
pull-requests: write
20+
21+
jobs:
22+
issue-manager:
23+
if: github.repository_owner == 'fastapi'
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Dump GitHub context
27+
env:
28+
GITHUB_CONTEXT: ${{ toJson(github) }}
29+
run: echo "$GITHUB_CONTEXT"
30+
- uses: tiangolo/[email protected]
31+
with:
32+
token: ${{ secrets.GITHUB_TOKEN }}
33+
config: >
34+
{
35+
"answered": {
36+
"delay": 864000,
37+
"message": "Assuming the original need was handled, this will be automatically closed now. But feel free to add more comments or create new issues or PRs."
38+
},
39+
"waiting": {
40+
"delay": 2628000,
41+
"message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR."
42+
}
43+
}

‎.github/workflows/labeler.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Labels
2+
on:
3+
pull_request_target:
4+
types:
5+
- opened
6+
- synchronize
7+
- reopened
8+
# For label-checker
9+
- labeled
10+
- unlabeled
11+
12+
jobs:
13+
labeler:
14+
permissions:
15+
contents: read
16+
pull-requests: write
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/labeler@v5
20+
# Run this after labeler applied labels
21+
check-labels:
22+
needs:
23+
- labeler
24+
permissions:
25+
pull-requests: read
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: docker://agilepathway/pull-request-label-checker:latest
29+
with:
30+
one_of: breaking,security,feature,bug,refactor,upgrade,docs,lang-all,internal
31+
repo_token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/latest-changes.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Latest Changes
2+
3+
on:
4+
pull_request_target:
5+
branches:
6+
- main
7+
types:
8+
- closed
9+
workflow_dispatch:
10+
inputs:
11+
number:
12+
description: PR number
13+
required: true
14+
debug_enabled:
15+
description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
16+
required: false
17+
default: 'false'
18+
19+
jobs:
20+
latest-changes:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Dump GitHub context
24+
env:
25+
GITHUB_CONTEXT: ${{ toJson(github) }}
26+
run: echo "$GITHUB_CONTEXT"
27+
- uses: actions/checkout@v4
28+
with:
29+
# To allow latest-changes to commit to the main branch
30+
token: ${{ secrets.LATEST_CHANGES }}
31+
# Allow debugging with tmate
32+
- name: Setup tmate session
33+
uses: mxschmitt/action-tmate@v3
34+
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
35+
with:
36+
limit-access-to-actor: true
37+
- uses: tiangolo/[email protected]
38+
with:
39+
token: ${{ secrets.GITHUB_TOKEN }}
40+
latest_changes_file: release-notes.md
41+
latest_changes_header: '## Latest Changes'
42+
end_regex: '^## '
43+
debug_logs: true
44+
label_header_prefix: '### '

0 commit comments

Comments
 (0)