Skip to content

Commit a8784a4

Browse files
aeiwzaeiwz
committed
Update feedback and issue report on document webpage
--- GitHub issue templates (.github/ISSUE_TEMPLATE/) - bug_report.md - rewritten with metbit-specific fields: affected module checkboxes, MRE code block, traceback, environment - feature_request.md - NMR metabolomics motivation, suggested API sketch, references - custom.md - lightweight Q&A template Floating feedback button (app/components/ReportIssueButton.tsx) - Pill button fixed bottom-right on every page - Links to /feedback /feedback page (app/feedback/) - page.tsx - standalone page with header and theme toggle - FeedbackForm.tsx - full client-side form with three modes: Bug report form fields - Title, description - required with inline validation - Affected area checkboxes - "Other" reveals a required text input - Steps to reproduce, expected behaviour, MRE code block, traceback - metbit version, Python version - OS dropdown (macOS, Windows, Ubuntu, Debian, Fedora, CentOS/RHEL, Other Linux, Other) - OS version dropdown - options change per OS, sorted by release year newest-first, includes "Other" with free-text fallback - Architecture chip selector (x86_64, ARM64, ARM32, Other) - Auto-detection on mount via Client Hints API (Chromium) with UA string fallback for Safari/Firefox - pre-fills OS, version, and arch; shows a notice the user can edit macOS versions - Tahoe (26), Sequoia (15), Sonoma (14), Ventura (13), Monterey (12), Big Sur (11)
1 parent d2ffb4c commit a8784a4

11 files changed

Lines changed: 822 additions & 45 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 40 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,49 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
3+
about: Something broken in metbit - preprocessing, analysis, visualization, or data loading
4+
title: '[Bug] '
5+
labels: bug
66
assignees: ''
77

88
---
99

1010
**Describe the bug**
11-
A clear and concise description of what the bug is.
12-
13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
19-
20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
22-
23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
11+
A clear and concise description of what went wrong.
12+
13+
**Affected area**
14+
<!-- Check all that apply -->
15+
- [ ] Data loading (Bruker reader, file import)
16+
- [ ] Preprocessing (baseline, normalisation, scaling, alignment)
17+
- [ ] Multivariate analysis (PCA, OPLS-DA)
18+
- [ ] Statistics (fold change, p-value, VIP)
19+
- [ ] Visualisation / Dash app
20+
- [ ] Other (describe below)
21+
22+
**Minimal reproducible example**
23+
```python
24+
import metbit
25+
26+
# paste the smallest code that triggers the bug
27+
```
28+
29+
**Error / traceback**
30+
```
31+
Paste the full traceback here
32+
```
33+
34+
**Expected behaviour**
35+
What should have happened instead?
36+
37+
**Environment**
38+
- metbit version: <!-- `import metbit; print(metbit.__version__)` -->
39+
- Python version: <!-- `python --version` -->
40+
- OS: <!-- e.g. macOS 14, Ubuntu 22.04, Windows 11 -->
41+
- Install method: <!-- pip / conda / from source -->
42+
43+
**Data context** *(optional)*
44+
- Instrument / pulse sequence:
45+
- Spectrum type: <!-- 1D ¹H, TOCSY, etc. -->
46+
- Approximate number of samples / variables:
3647

3748
**Additional context**
38-
Add any other context about the problem here.
49+
Any other information, screenshots of plots, or links to related issues.

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
11
---
2-
name: Custom issue template
3-
about: Describe this issue template's purpose here.
4-
title: ''
5-
labels: ''
2+
name: Question / other
3+
about: Ask a question about metbit usage, data interpretation, or report a documentation gap
4+
title: '[Question] '
5+
labels: question
66
assignees: ''
77

88
---
99

10+
**What are you trying to do?**
11+
Describe your goal in the context of your NMR metabolomics workflow.
1012

13+
**What have you tried?**
14+
```python
15+
import metbit
16+
17+
# show what you attempted
18+
```
19+
20+
**metbit version**
21+
<!-- `import metbit; print(metbit.__version__)` -->
22+
23+
**Additional context**
24+
Any other information, links, or screenshots that might help.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,36 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
3+
about: Suggest a new capability for metbit
4+
title: '[Feature] '
5+
labels: enhancement
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
**Which part of the metbit workflow does this relate to?**
11+
<!-- Check all that apply -->
12+
- [ ] Data loading / file format support
13+
- [ ] Preprocessing (new method or option)
14+
- [ ] Multivariate analysis (new model or output)
15+
- [ ] Statistics (new test or metric)
16+
- [ ] Visualisation / Dash app
17+
- [ ] API / usability improvement
18+
- [ ] Other (describe below)
1219

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
20+
**Describe the feature**
21+
A clear and concise description of what you want metbit to be able to do.
1522

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
23+
**Why is this useful for NMR metabolomics workflows?**
24+
Explain the scientific or practical motivation.
25+
26+
**Suggested API** *(optional)*
27+
```python
28+
# How you imagine using it
29+
result = metbit.SomeNewFunction(data, param=value)
30+
```
31+
32+
**References** *(optional)*
33+
Links to papers, existing tools, or similar implementations that could inform the design.
1834

1935
**Additional context**
20-
Add any other context or screenshots about the feature request here.
36+
Any other information or screenshots.

‎docs/app/components/ReportIssueButton.tsx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
'use client'
2+
3+
import Link from 'next/link'
4+
import { FiAlertCircle } from 'react-icons/fi'
5+
6+
export default function ReportIssueButton() {
7+
return (
8+
<Link
9+
href="/feedback"
10+
className="reportIssueBtn"
11+
aria-label="Report issue or give feedback"
12+
title="Feedback"
13+
>
14+
<FiAlertCircle aria-hidden />
15+
<span>Feedback</span>
16+
</Link>
17+
)
18+
}

0 commit comments

Comments
 (0)