Skip to content

Commit a6e7445

Browse files
tiangolotiangolo
authored
👷 Add templates and admin CI workflows (#3)
1 parent 9bc49cd commit a6e7445

File tree

4 files changed

+171
-0
lines changed

4 files changed

+171
-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 the 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+
By asking questions in a structured way (following this) it will be much easier to help you.
15+
16+
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. 😎
17+
18+
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. 🤓
19+
- type: checkboxes
20+
id: checks
21+
attributes:
22+
label: First Check
23+
description: Please confirm and check all the following options.
24+
options:
25+
- label: I added a very descriptive title here.
26+
required: true
27+
- label: I used the GitHub search to find a similar question and didn't find it.
28+
required: true
29+
- label: I already searched in Google "How to X with annotated-doc" and didn't find any information.
30+
required: true
31+
- label: I already read and followed all the tutorial in the docs and didn't find an answer.
32+
required: true
33+
- label: I already checked if it is not related to annotated-doc but to [FastAPI](https://github.com/fastapi/fastapi) or another specific project.
34+
required: true
35+
- type: textarea
36+
id: example
37+
attributes:
38+
label: Example Code
39+
description: |
40+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
41+
42+
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.
43+
44+
placeholder: |
45+
from typing import Annotated
46+
47+
from annotated_doc import Doc
48+
49+
def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None:
50+
print(f"Hi!")
51+
render: python
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: description
56+
attributes:
57+
label: Description
58+
description: |
59+
What is the problem, question, or error?
60+
61+
Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
62+
placeholder: |
63+
* Create a function with one parameter documented with annotated-doc.
64+
* Call the function with the parameter.
65+
* I expected the code to do what the docs say, but it doesn't unless I implement that code.
66+
validations:
67+
required: true
68+
- type: dropdown
69+
id: os
70+
attributes:
71+
label: Operating System
72+
description: What operating system are you on?
73+
multiple: true
74+
options:
75+
- Linux
76+
- Windows
77+
- macOS
78+
- Other
79+
validations:
80+
required: true
81+
- type: textarea
82+
id: os-details
83+
attributes:
84+
label: Operating System Details
85+
description: You can add more details about your operating system here, in particular if you chose "Other".
86+
- type: input
87+
id: version
88+
attributes:
89+
label: Version
90+
description: |
91+
What version are you using?
92+
93+
You can find the version with:
94+
95+
```bash
96+
python -c "import annotated_doc; print(annotated_doc.__version__)"
97+
```
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/ISSUE_TEMPLATE/config.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Contact
4+
about: Please report security vulnerabilities to security@tiangolo.com
5+
- name: Question or Problem
6+
about: Ask a question or ask about a problem in GitHub Discussions.
7+
url: https://github.com/fastapi/annotated-doc/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/annotated-doc/discussions/categories/questions
11+
- name: Show and tell
12+
about: Show what you built with annotated-doc and where you use it.
13+
url: https://github.com/fastapi/annotated-doc/discussions/categories/show-and-tell

‎.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 annotated-doc! 🚀
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/fastapi/annotated-doc/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/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/add-to-project@v1.0.2
16+
with:
17+
project-url: https://github.com/orgs/fastapi/projects/2
18+
github-token: ${{ secrets.FASTAPI_PROJECTS_TOKEN }}

0 commit comments

Comments
 (0)