Local project checks and contribution templates: make check, dependency-free C/python tests, issue forms + blank issues, CONTRIBUTING (#20)

* Add lightweight project checks and templates

* Ignore generated test binaries

* Keep project checks local
This commit is contained in:
ZacharyZcR
2026-07-10 14:56:41 +08:00
committed by GitHub
parent 99111993a4
commit 8a2e4439ba
12 changed files with 276 additions and 6 deletions
+43
View File
@@ -0,0 +1,43 @@
name: Bug report
description: Report a reproducible defect in Colibri.
title: "[Bug]: "
body:
- type: markdown
attributes:
value: Thanks for taking the time to provide a reproducible report.
- type: input
id: version
attributes:
label: Commit or version
description: Paste the exact commit hash when possible.
placeholder: git rev-parse HEAD
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Include OS, CPU, RAM, GPU/CUDA if enabled, compiler, and storage type.
placeholder: Ubuntu 24.04, Ryzen 7950X, 64 GB RAM, NVMe, gcc 13
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Reproduction steps
description: Include the exact build and run commands with sensitive paths removed.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior and logs
render: shell
validations:
required: true
+1
View File
@@ -0,0 +1 @@
blank_issues_enabled: true
@@ -0,0 +1,26 @@
name: Feature request
description: Propose a focused improvement to Colibri.
title: "[Feature]: "
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What real limitation or workflow problem does this address?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
- type: textarea
id: scope
attributes:
label: Scope and compatibility
description: Note effects on the zero-dependency CPU path, CUDA path, model formats, or platforms.
@@ -0,0 +1,45 @@
name: Performance report
description: Report a benchmark result or performance regression.
title: "[Performance]: "
body:
- type: input
id: commit
attributes:
label: Commit
placeholder: git rev-parse HEAD
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware and storage
description: Include CPU, RAM, GPU/VRAM, disk model/type, and filesystem.
validations:
required: true
- type: textarea
id: software
attributes:
label: Software environment
description: Include OS, compiler, CUDA/driver versions, and relevant environment variables.
validations:
required: true
- type: textarea
id: command
attributes:
label: Build and benchmark commands
render: shell
validations:
required: true
- type: textarea
id: results
attributes:
label: Results
description: Include warm-up policy, run count, median tok/s, and profile timings when available.
render: text
validations:
required: true
- type: textarea
id: comparison
attributes:
label: Baseline comparison
description: For regressions, provide the last known-good commit and its result.
+14
View File
@@ -0,0 +1,14 @@
## Summary
Describe the problem and the smallest change that solves it.
## Validation
- [ ] `make -C c check`
- [ ] CUDA changes were tested with `make -C c cuda-test` (if applicable)
- [ ] Performance claims include hardware, commands, and repeatable measurements
## Compatibility
- [ ] The default CPU build remains dependency-free
- [ ] No model files, generated binaries, or benchmark artifacts are included