Skip to content

Add GitHub issue templates and improve check.py diagnostics#295

Merged
blink1073 merged 3 commits into
Calysto:mainfrom
blink1073:issue-templates
Mar 15, 2026
Merged

Add GitHub issue templates and improve check.py diagnostics#295
blink1073 merged 3 commits into
Calysto:mainfrom
blink1073:issue-templates

Conversation

@blink1073
Copy link
Copy Markdown
Contributor

References

N/A

Description

Adds bug report and feature request issue templates for GitHub. Also improves the python -m octave_kernel.check diagnostic output so the bug report template can direct users to run it instead of manually filling in environment details.

Changes

  • Add .github/ISSUE_TEMPLATE/bug_report.md with sections for description, steps to reproduce, expected/actual behavior, diagnostics (python -m octave_kernel.check), screenshots, and severity
  • Add .github/ISSUE_TEMPLATE/feature_request.md with sections for problem, proposed solution, alternatives, user value/impact, and additional context
  • Update check.py to print OS info and Jupyter client version; import jupyter_client unconditionally at module level

Backwards-incompatible changes

None

Testing

N/A

AI usage

  • AI tools were used in creating this PR
  • The human author has reviewed all AI-generated content

Tools used: Claude Sonnet 4.6 via Claude Code

- Add bug report and feature request issue templates under .github/ISSUE_TEMPLATE/
- Extend check.py to report OS, Jupyter client version; import jupyter_client unconditionally
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.62%. Comparing base (e385543) to head (6363192).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #295      +/-   ##
==========================================
+ Coverage   91.54%   91.62%   +0.07%     
==========================================
  Files           6        6              
  Lines         426      430       +4     
==========================================
+ Hits          390      394       +4     
  Misses         36       36              
Flag Coverage Δ
linux 91.39% <100.00%> (+0.08%) ⬆️
windows 91.62% <100.00%> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
octave_kernel/check.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

blink1073 and others added 2 commits March 15, 2026 09:41
Use importlib.metadata.version() instead of jupyter_client.__version__
to avoid mypy attr-defined error
@blink1073 blink1073 enabled auto-merge (squash) March 15, 2026 14:44
@blink1073 blink1073 merged commit 9ccd573 into Calysto:main Mar 15, 2026
27 checks passed
@blink1073 blink1073 deleted the issue-templates branch March 15, 2026 14:55
@blink1073 blink1073 mentioned this pull request Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant