Skip to content

Commit 3f4da91

Browse files
karangattukarangattu
committed
Add some issue template
1 parent a06b3fe commit 3f4da91

File tree

3 files changed

+494
-0
lines changed

3 files changed

+494
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
name: Bug Report
2+
description: Report a bug in Shiny for Python
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
10+
11+
Providing a **Minimal Reproducible Example** is crucial for us to quickly understand and fix the issue.
12+
Please take the time to create a minimal app that demonstrates the bug. Templates are provided in the "Minimal Reproducible Example" section.
13+
14+
**Please ensure you have searched for similar issues before submitting.** Duplicates slow down the process of fixing bugs.
15+
16+
- type: dropdown
17+
id: component
18+
attributes:
19+
label: Component
20+
description: Which part of Shiny for Python is affected?
21+
options:
22+
- UI Components (ui.*)
23+
- Server Logic (server.*)
24+
- Reactive Programming
25+
- Input Bindings
26+
- Output Bindings
27+
- Session Management
28+
- App Deployment
29+
- Documentation
30+
- Installation
31+
- Other
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: severity
37+
attributes:
38+
label: Severity
39+
description: How severe is this issue?
40+
options:
41+
- P0 - Critical (App crashes/unusable, blocking core functionality)
42+
- P1 - High (Major feature broken, significant impact on usability)
43+
- P2 - Medium (Feature works with workaround, noticeable impact)
44+
- P3 - Low (Minor inconvenience, cosmetic issue, or documentation suggestion)
45+
validations:
46+
required: true
47+
48+
- type: input
49+
id: version
50+
attributes:
51+
label: Shiny Version
52+
description: What version of Shiny for Python are you using? (Check `shiny --version` in your terminal)
53+
placeholder: ex. 1.0.2
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: python-version
59+
attributes:
60+
label: Python Version
61+
description: What version of Python are you using? (Check `python --version` in your terminal)
62+
placeholder: ex. 3.10.6
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: minimal-example
68+
attributes:
69+
label: Minimal Reproducible Example
70+
description: |
71+
Please provide a *minimal*, self-contained Shiny app that clearly demonstrates the issue.
72+
This is **the most important part** of your bug report. The easier it is for us to reproduce the bug, the faster we can fix it.
73+
74+
* **Minimal:** Remove any code not directly related to the bug.
75+
* **Reproducible:** We should be able to copy and paste your code and run it to see the bug.
76+
* **Self-contained:** Include all necessary code in one file if possible.
77+
78+
Templates:
79+
80+
```python
81+
from shiny import App, render, ui
82+
83+
app_ui = ui.page_fluid(
84+
# Your UI code here
85+
)
86+
87+
def server(input, output, session):
88+
# Your server code here
89+
pass
90+
91+
app = App(app_ui, server)
92+
```
93+
render: python
94+
validations:
95+
required: true
96+
97+
- type: textarea
98+
id: current-behavior
99+
attributes:
100+
label: Current Behavior
101+
description: A clear and concise description of what you are seeing happen. Be specific.
102+
placeholder: When I click the button labeled "Update Plot", the app freezes and I see a spinner, but the plot does not update.
103+
validations:
104+
required: true
105+
106+
- type: textarea
107+
id: expected-behavior
108+
attributes:
109+
label: Expected Behavior
110+
description: A clear and concise description of what you expected to happen instead.
111+
placeholder: I expected the plot to update with new data points after clicking the "Update Plot" button, without freezing the app.
112+
validations:
113+
required: true
114+
115+
- type: textarea
116+
id: error-messages
117+
attributes:
118+
label: Error Messages (if any)
119+
description: Please copy and paste any relevant error messages or tracebacks. If there are no error messages, you can leave this blank.
120+
render: shell
121+
122+
- type: textarea
123+
id: environment
124+
attributes:
125+
label: Environment Information
126+
description: |
127+
Please provide details about your development/runtime environment. This information is very helpful for debugging.
128+
129+
**Please fill in the details below:**
130+
value: |
131+
- Operating System: [e.g., Windows 10, macOS 13.4, Ubuntu 20.04]
132+
- Browser: [e.g., Chrome 114, Firefox 115, Safari 16]
133+
- Key Dependencies (from `pip freeze` or `conda list`):
134+
- shiny: [e.g., 1.0.2]
135+
- pandas: [e.g., 2.0.0]
136+
- numpy: [e.g., 1.23.0]
137+
- plotly: [e.g., 5.15.0]
138+
- matplotlib: [e.g., 3.7.0]
139+
- any other relevant packages: [e.g., `requests==2.28.1`]
140+
render: markdown
141+
validations:
142+
required: true
143+
144+
- type: textarea
145+
id: additional-context
146+
attributes:
147+
label: Additional Context
148+
description: |
149+
Add any other context or information about the problem here. This could include:
150+
- Browser console logs (if relevant to UI issues)
151+
- Screenshots or screen recordings
152+
- Performance profiles
153+
- Specific steps to reproduce the issue if your minimal example is still complex.
154+
155+
- type: checkboxes
156+
id: terms
157+
attributes:
158+
label: Code of Conduct
159+
description: By submitting this issue, you agree to follow our Code of Conduct. Please read it [link to Code of Conduct].
160+
options:
161+
- label: I agree to follow this project's Code of Conduct
162+
required: true
163+
164+
- type: checkboxes
165+
id: checks
166+
attributes:
167+
label: Final Checks
168+
description: Before submitting, please make sure you've completed these checks to help us resolve your issue faster.
169+
options:
170+
- label: I have searched for similar issues in the repository to avoid duplicates.
171+
- label: I have tested with the latest version of Shiny for Python to ensure the bug still exists.
172+
- label: I have included a minimal reproducible example that clearly demonstrates the issue.
173+
- label: I have filled out all required fields in this issue template to the best of my ability.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
name: Documentation Issue
2+
description: Report a documentation issue or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve Shiny for Python's documentation! Your contributions are highly valued.
10+
11+
Please provide as much detail as possible about the documentation issue or suggestion.
12+
**Even if a field is marked as optional, providing the information is highly encouraged** to help us understand and address the issue effectively.
13+
14+
- type: dropdown
15+
id: doc-type
16+
attributes:
17+
label: Documentation Type
18+
description: What type of documentation does this issue relate to?
19+
options:
20+
- API Reference (Function/Class documentation)
21+
- Tutorials/Guides (Longer, step-by-step instructions)
22+
- Examples Gallery (Code examples)
23+
- Getting Started (Installation, basic usage)
24+
- Conceptual Guides (Explanations of core concepts)
25+
- Function Docstrings (Documentation within the Python code)
26+
- Code Comments
27+
- Installation Instructions
28+
- Deployment Guides
29+
- Other
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: doc-location
35+
attributes:
36+
label: Documentation Location
37+
description: Where is the documentation you're referring to? Please be as specific as possible. (URL or file path if you know it)
38+
placeholder: "e.g., https://shiny.rstudio.com/py/docs/reactive-programming.html or `shiny/ui/__init__.py`"
39+
validations:
40+
required: true
41+
42+
- type: dropdown
43+
id: issue-type
44+
attributes:
45+
label: Issue Type
46+
description: What kind of documentation issue is this?
47+
options:
48+
- Missing Documentation (Something is not documented)
49+
- Incorrect Information (Documentation is factually wrong)
50+
- Unclear Explanation (Difficult to understand)
51+
- Outdated Content (Documentation is no longer current)
52+
- Broken Links/References
53+
- Code Example Issue (Example doesn't work or is unclear)
54+
- Grammar/Typo
55+
- Translation Issue (For translated documentation)
56+
- Enhancement Suggestion (Improve clarity, add detail, etc.)
57+
- Other
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: current-content
63+
attributes:
64+
label: Current Content (Optional, but helpful)
65+
description: If applicable, please paste the relevant section of the current documentation. This helps us quickly locate the issue.
66+
placeholder: |
67+
Please paste the relevant current documentation text here...
68+
(Leave blank if not directly applicable or for missing documentation issues)
69+
70+
- type: textarea
71+
id: suggested-content
72+
attributes:
73+
label: Suggested Changes (Highly encouraged)
74+
description: |
75+
What changes would you like to see? Please be as specific as possible.
76+
If you have a suggested text or code, please provide it here.
77+
78+
For code examples, use markdown code blocks:
79+
80+
```python
81+
from shiny import App, ui
82+
# Your example code here
83+
```
84+
placeholder: |
85+
Please provide your suggested improvements or new content here.
86+
(If you have a specific wording or code example in mind, please include it here)
87+
88+
- type: textarea
89+
id: motivation
90+
attributes:
91+
label: Motivation (Optional, but helpful)
92+
description: Why is this change needed? How will it help users of Shiny for Python? Explaining the impact is very helpful.
93+
placeholder: |
94+
Explain why this documentation improvement would be valuable...
95+
(e.g., "This clarification will prevent users from misunderstanding X", "This example will make it easier to learn Y")
96+
97+
- type: textarea
98+
id: additional-context
99+
attributes:
100+
label: Additional Context
101+
description: Add any other context, screenshots, screen recordings, or details that might be helpful in understanding the documentation issue.
102+
103+
- type: input
104+
id: shiny-version
105+
attributes:
106+
label: Shiny Version (Optional, if applicable)
107+
description: Which version of Shiny for Python are you using? (Only relevant if the documentation issue is version-specific)
108+
placeholder: ex. 1.0.2
109+
110+
- type: checkboxes
111+
id: preliminary-checks
112+
attributes:
113+
label: Preliminary Checks
114+
description: Please confirm the following before submitting.
115+
options:
116+
- label: I have searched existing issues to avoid duplicate documentation requests.
117+
required: true
118+
- label: I have checked the latest documentation on the website/main branch to ensure this hasn't already been addressed.
119+
required: true
120+
- label: This issue is clearly a documentation issue or suggestion, and not a bug report or feature request.
121+
required: true
122+
123+
- type: checkboxes
124+
id: contribution
125+
attributes:
126+
label: Contribution (Optional)
127+
description: Would you be interested in helping with this documentation improvement? Your help is welcome!
128+
options:
129+
- label: I would be willing to submit a pull request with these changes
130+
required: false
131+
- label: I would be willing to review proposed changes
132+
required: false
133+
134+
- type: checkboxes
135+
id: terms
136+
attributes:
137+
label: Code of Conduct
138+
description: By submitting this issue, you agree to follow our Code of Conduct. You can find it [link to Code of Conduct - Replace with actual link].
139+
options:
140+
- label: I agree to follow this project's Code of Conduct
141+
required: true

0 commit comments

Comments
 (0)