Skip to content

Commit 68b85aa

Browse files
committed
Add issue templates for bug reports and feature requests
1 parent 9856ecc commit 68b85aa

4 files changed

Lines changed: 184 additions & 0 deletions

File tree

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Bug Report
2+
description: Report a reproducible problem in Soil
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting this issue. Please fill out as much detail as possible so we can reproduce and fix it quickly.
11+
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Summary
16+
description: A clear and concise description of the bug.
17+
placeholder: Example: Pull fails when project path contains spaces.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to Reproduce
25+
description: List exact steps to trigger the issue.
26+
placeholder: |
27+
1. Open Soil
28+
2. Clone Overleaf project X
29+
3. Click Pull
30+
4. Observe error
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected Behavior
38+
description: What should have happened?
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What happened instead? Include error messages.
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: os
52+
attributes:
53+
label: Operating System
54+
options:
55+
- Windows
56+
- macOS
57+
- Linux
58+
- Other
59+
validations:
60+
required: true
61+
62+
- type: input
63+
id: version
64+
attributes:
65+
label: Soil Version
66+
description: Which version are you using?
67+
placeholder: Example: 1.0.0
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: logs
73+
attributes:
74+
label: Logs or Screenshots
75+
description: Paste relevant logs or drag screenshots here.
76+
render: shell
77+
78+
- type: checkboxes
79+
id: checks
80+
attributes:
81+
label: Checklist
82+
options:
83+
- label: I searched existing issues before opening this.
84+
required: true
85+
- label: I can reproduce this issue on the latest release.
86+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions and Discussion
4+
url: https://github.com/RaymonDev/soil/discussions
5+
about: Ask usage questions, share ideas, or start broader discussions.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Feature Request
2+
description: Suggest an idea to improve Soil
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for the idea. Well-scoped requests are easier to prioritize and ship.
11+
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Problem to Solve
16+
description: What pain point are you facing?
17+
placeholder: Example: I cannot compare local and remote file versions before pushing.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: proposal
23+
attributes:
24+
label: Proposed Solution
25+
description: Describe the feature you want.
26+
placeholder: Example: Add a side-by-side diff panel in the push dialog.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: alternatives
32+
attributes:
33+
label: Alternatives Considered
34+
description: Any workarounds or alternative approaches?
35+
36+
- type: dropdown
37+
id: area
38+
attributes:
39+
label: Area
40+
options:
41+
- Editor
42+
- Compiler
43+
- Overleaf Sync
44+
- PDF Preview
45+
- Project Management
46+
- Settings
47+
- Other
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: impact
53+
attributes:
54+
label: Expected Impact
55+
description: Who benefits and how?
56+
placeholder: Example: Fewer merge mistakes when collaborating offline.
57+
58+
- type: checkboxes
59+
id: checks
60+
attributes:
61+
label: Checklist
62+
options:
63+
- label: I searched existing issues before opening this.
64+
required: true
65+
- label: This request is focused on a single feature.
66+
required: true

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
</ul>
5858
</li>
5959
<li><a href="#keyboard-shortcuts">Keyboard Shortcuts</a></li>
60+
<li><a href="#roadmap">Roadmap</a></li>
6061
<li><a href="#contributing">Contributing</a></li>
6162
<li><a href="#license">License</a></li>
6263
</ol>
@@ -207,6 +208,32 @@ Output goes to `release/`.
207208

208209

209210

211+
<!-- ROADMAP -->
212+
## Roadmap
213+
214+
Tracks active work and near-term priorities.
215+
216+
- [x] One-click Overleaf auth (SSO + 2FA compatible)
217+
- [x] Local TinyTeX + MinGit bootstrap
218+
- [x] Monaco diagnostics + PDF live preview
219+
- [ ] Two-way Sync UX improvements (conflict hints + guided resolution)
220+
- [ ] Integrated commit history panel inside the app
221+
- [ ] Rich diff view before push (side-by-side)
222+
- [ ] Project-level settings sync (theme, auto-compile mode)
223+
- [ ] Crash reporting and anonymous diagnostics opt-in
224+
225+
### Next Milestones
226+
227+
- **v1.1**: Better sync conflict visibility and safer push flows.
228+
- **v1.2**: In-app history, cleaner project browser filters, and quality-of-life editor upgrades.
229+
- **v1.3**: Stability pass, startup performance improvements, and expanded offline workflow polish.
230+
231+
Have an idea? Open a feature request below so it can be reviewed and added to the roadmap.
232+
233+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
234+
235+
236+
210237
<!-- CONTRIBUTING -->
211238
## Contributing
212239

0 commit comments

Comments
 (0)