Skip to content

Commit ae86956

Browse files
committed
Add GitHub Issues section to CLAUDE.md
Adds a 'GitHub Issues' section to .claude/CLAUDE.md that documents using `gh issue create` for SciSharp/NumSharp and notes GH_TOKEN availability via the env-tokens skill. Provides structured templates for Feature/Enhancement and Bug Report issues (checklists and fields such as overview, problem/proposal, evidence, scope, benchmarks, breaking changes, reproduction, expected/actual behavior, workaround, root cause, and related issues) to standardize reporting.
1 parent 15a9d79 commit ae86956

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

.claude/CLAUDE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,30 @@ Apply at class level (`[TestClass][TestCategory("OpenBugs")]`) or individual met
354354
## CI Pipeline
355355

356356
`.github/workflows/build-and-release.yml` — test on 3 OSes (Windows/Ubuntu/macOS), build NuGet on tag push, create GitHub Release, publish to nuget.org.
357+
## GitHub Issues
358+
359+
Create issues on `SciSharp/NumSharp` via `gh issue create`. `GH_TOKEN` is available via the `env-tokens` skill.
360+
361+
### Feature / Enhancement
362+
363+
- **Overview**: 1-2 sentence summary of what and why
364+
- **Problem**: What's broken or missing, why it matters
365+
- **Proposal**: What to change, with a task checklist (`- [ ]`)
366+
- **Evidence**: Data, benchmarks, or references supporting the proposal
367+
- **Scope / Non-goals**: What this issue does NOT cover (prevent scope creep)
368+
- **Benchmark / Performance** (if applicable): Before/after numbers, methodology, what to measure
369+
- **Breaking changes** table (if any): Change | Impact | Migration
370+
- **Related issues**: Link dependencies
371+
372+
### Bug Report
373+
374+
- **Overview**: 1-2 sentence summary of the bug and its impact
375+
- **Reproduction**: Minimal code to trigger the bug
376+
- **Expected**: Correct behavior (include NumPy output as source of truth)
377+
- **Actual**: What NumSharp does instead (error message, wrong output, crash)
378+
- **Workaround** (if any): How users can avoid the bug today
379+
- **Root cause** (if known): File, line, why it happens
380+
- **Related issues**: Link duplicates or upstream causes
357381

358382
## Scripting with `dotnet run` (.NET 10 file-based apps)
359383

0 commit comments

Comments
 (0)