chore: add contribution workflow and experiment templates
This commit is contained in:
1 parent
48b699ad6b
commit
9d54405cc9
8 files changed
+216
No files matched your search
@@ -0,0 +1,31 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Report a reproducible problem in an existing experiment
|
||||
title: ""
|
||||
---
|
||||
|
||||
## Experiment and version
|
||||
|
||||
Link the affected directory and identify the commit or version.
|
||||
|
||||
## What happened?
|
||||
|
||||
Describe the observed result and what you expected.
|
||||
|
||||
## Reproduce it
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Environment
|
||||
|
||||
Operating system, browser or runtime version, and relevant configuration. Use placeholder values for private configuration.
|
||||
|
||||
## Evidence
|
||||
|
||||
Include a minimal example or redacted screenshot/log. Do not post credentials, tokens, personal records, or private URLs.
|
||||
|
||||
## Checks already tried
|
||||
|
||||
State what you tried and what happened.
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
name: Experiment idea
|
||||
about: Propose a small experiment or improvement
|
||||
title: ""
|
||||
---
|
||||
|
||||
## The idea
|
||||
|
||||
What would you like to explore or improve?
|
||||
|
||||
## Who would use it?
|
||||
|
||||
Explain the problem or question in concrete terms.
|
||||
|
||||
## Smallest useful version
|
||||
|
||||
Describe a bounded first version and what is outside its scope.
|
||||
|
||||
## How would we check it?
|
||||
|
||||
What result would show it works? What assumptions need testing?
|
||||
|
||||
## Sources and constraints
|
||||
|
||||
Link relevant public references. Note data, license, accessibility, or dependency constraints without sharing private material.
|
||||
@@ -0,0 +1,24 @@
|
||||
## Purpose
|
||||
|
||||
Explain the problem or question this change addresses. Link a related issue if one exists.
|
||||
|
||||
## Changes
|
||||
|
||||
-
|
||||
|
||||
## Verification
|
||||
|
||||
List exact commands or manual checks and their results. State what was not tested. Add screenshots for visual changes where useful.
|
||||
|
||||
## Review checklist
|
||||
|
||||
- [ ] The change is focused and documented.
|
||||
- [ ] Setup and usage instructions match the actual files.
|
||||
- [ ] New experiments are listed in docs/experiments.md.
|
||||
- [ ] Sources and required license notices are included.
|
||||
- [ ] Files, screenshots, and staged changes contain no secrets or private material.
|
||||
- [ ] Limitations and unrun checks are stated clearly.
|
||||
|
||||
## Risks or follow-up
|
||||
|
||||
Describe remaining gaps, compatibility concerns, or rollback steps. Mark checklist items not applicable with an explanation.
|
||||
Reference in new issue
Block a user