Skip to content

Commit 0fae328

Browse files
tchapitchapi
authored
issue templates (#250)
1 parent 82f6f2e commit 0fae328

File tree

2 files changed

+215
-0
lines changed

2 files changed

+215
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
name: Bug Report
2+
description: Something is not working as expected
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before opening an issue, please:
9+
- Check `./var/log/prod.log` for errors (only written when errors occur, thanks to the `fingers_crossed` filter)
10+
- Check your web server / reverse proxy logs
11+
- Read the [Troubleshooting section of the README](https://github.com/tchapi/davis/blob/main/README.md#troubleshooting)
12+
13+
- type: input
14+
id: davis_version
15+
attributes:
16+
label: Davis version
17+
description: Tag or commit SHA. Found on the `/` status page or via `git describe --tags`.
18+
placeholder: "e.g. v5.1.0"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: install_method
24+
attributes:
25+
label: Installation method
26+
options:
27+
- Docker – standalone (with Caddy)
28+
- Docker – barebone (no reverse proxy)
29+
- Bare metal / manual
30+
- NixOS module
31+
- Other (describe below)
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: php_version
37+
attributes:
38+
label: PHP version (bare metal only)
39+
description: Output of `php --version`. Skip if using Docker.
40+
placeholder: "e.g. 8.2.18"
41+
42+
- type: dropdown
43+
id: database
44+
attributes:
45+
label: Database
46+
options:
47+
- MySQL
48+
- MariaDB
49+
- PostgreSQL
50+
- SQLite
51+
- Other
52+
validations:
53+
required: true
54+
55+
- type: dropdown
56+
id: reverse_proxy
57+
attributes:
58+
label: Reverse proxy
59+
options:
60+
- None (standalone Docker with Caddy)
61+
- Nginx
62+
- Apache
63+
- Caddy
64+
- Traefik
65+
- Other
66+
validations:
67+
required: true
68+
69+
- type: dropdown
70+
id: auth_method
71+
attributes:
72+
label: Authentication method
73+
options:
74+
- Internal (ADMIN_LOGIN / ADMIN_PASSWORD)
75+
- IMAP
76+
- LDAP
77+
validations:
78+
required: true
79+
80+
- type: checkboxes
81+
id: protocols
82+
attributes:
83+
label: Affected protocol(s)
84+
options:
85+
- label: CalDAV
86+
- label: CardDAV
87+
- label: WebDAV
88+
- label: Admin dashboard
89+
- label: API
90+
91+
- type: textarea
92+
id: client
93+
attributes:
94+
label: Client(s) exhibiting the issue
95+
description: Name, version, OS/platform. Add multiple if relevant.
96+
placeholder: |
97+
- DAVx⁵ 4.3.14 on Android 14
98+
- Apple Calendar on macOS 14.4
99+
- Thunderbird 115.10 on Ubuntu 22.04
100+
validations:
101+
required: true
102+
103+
- type: textarea
104+
id: env_vars
105+
attributes:
106+
label: Relevant environment variables
107+
description: |
108+
Sanitize secrets (APP_SECRET, DATABASE_URL password, API_KEY, etc.).
109+
Include at minimum: APP_ENV, CALDAV_ENABLED, CARDDAV_ENABLED, WEBDAV_ENABLED, AUTH_METHOD, and any env vars you think are relevant.
110+
render: shell
111+
placeholder: |
112+
APP_ENV=prod
113+
AUTH_METHOD=...
114+
CALDAV_ENABLED=true
115+
CARDDAV_ENABLED=true
116+
WEBDAV_ENABLED=false
117+
DATABASE_URL=mysql://user:***@host:3306/davis
118+
validations:
119+
required: true
120+
121+
- type: textarea
122+
id: steps
123+
attributes:
124+
label: Steps to reproduce
125+
placeholder: |
126+
1. Configure client with URL https://dav.example.com/dav
127+
2. ...
128+
3. Observe error
129+
validations:
130+
required: true
131+
132+
- type: textarea
133+
id: expected
134+
attributes:
135+
label: Expected behaviour
136+
validations:
137+
required: true
138+
139+
- type: textarea
140+
id: actual
141+
attributes:
142+
label: Actual behaviour
143+
description: Include any error messages shown in the UI or client.
144+
validations:
145+
required: true
146+
147+
- type: textarea
148+
id: logs
149+
attributes:
150+
label: Logs
151+
description: |
152+
Paste the relevant section of `./var/log/prod.log` (relative to your Davis installation root, **not** `/var/log`).
153+
Also include web server / reverse proxy error logs if applicable.
154+
Set `APP_ENV=dev` temporarily to get verbose output if `prod.log` is empty (you need to install dev dependencies with composer).
155+
render: text
156+
157+
- type: textarea
158+
id: additional
159+
attributes:
160+
label: Additional context
161+
description: Anything else that might be relevant (docker-compose snippet, nginx config excerpt, network topology, etc.).

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature Request
2+
description: Suggest an improvement or new functionality
3+
labels: ["feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please check [existing issues](https://github.com/tchapi/davis/issues) and the [Davis roadmap](https://github.com/users/tchapi/projects/1) first to avoid duplicates.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem / motivation
14+
description: What are you trying to do, and why is it currently not possible or inconvenient?
15+
placeholder: "e.g. I cannot do X, which forces me to..."
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: solution
21+
attributes:
22+
label: Proposed solution
23+
description: Describe the feature you have in mind. Be as specific as possible.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: alternatives
29+
attributes:
30+
label: Alternatives considered
31+
description: Other approaches you have thought of or tried, and why they fall short.
32+
33+
- type: dropdown
34+
id: area
35+
attributes:
36+
label: Area
37+
options:
38+
- CalDAV
39+
- CardDAV
40+
- WebDAV
41+
- Admin dashboard
42+
- API
43+
- Authentication (IMAP / LDAP / internal)
44+
- Docker / deployment
45+
- Documentation
46+
- Other
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: additional
52+
attributes:
53+
label: Additional context
54+
description: Links, screenshots, references to relevant RFCs or client behaviour, etc.

0 commit comments

Comments
 (0)