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 @@
|
||||
# Experiment name
|
||||
|
||||
Replace this template with concrete details before publishing an experiment.
|
||||
|
||||
## Purpose
|
||||
|
||||
What question does this explore or what problem does it solve? Who is it for?
|
||||
|
||||
## Status
|
||||
|
||||
Idea / prototype / usable / archived. State the main limitation and what works today.
|
||||
|
||||
## Try it
|
||||
|
||||
List prerequisites and exact dependency, setup, and run commands. Include synthetic sample input and expected output. Explain how to stop it and remove any temporary data. If there is no executable code, say how to inspect or use the artifact.
|
||||
|
||||
## Checks
|
||||
|
||||
Record reproducible checks and actual results. Separate automated tests, manual checks, and checks not yet run. For visual work, document relevant screen sizes and accessibility checks.
|
||||
|
||||
## Data and privacy
|
||||
|
||||
Explain where sample data comes from and whether anything leaves the local machine. Never include credentials or private records. Document configuration using placeholder values only.
|
||||
|
||||
## Limitations and next steps
|
||||
|
||||
List known gaps and the smallest useful next step. Avoid implying production readiness.
|
||||
|
||||
## Sources and license
|
||||
|
||||
Credit reused code, data, images, and other material with source links and applicable licenses. Retain required notices.
|
||||
@@ -0,0 +1,18 @@
|
||||
# Experiment index
|
||||
|
||||
No experiments have been published in this repository yet. This index tracks actual project directories rather than planned features.
|
||||
|
||||
When adding a project, include a relative link, a one-sentence purpose, status, and a quick way to run it. Start with [the experiment README template](experiment-template.md).
|
||||
|
||||
## Status guide
|
||||
|
||||
- **Idea:** a written question or proposal; no working implementation claimed.
|
||||
- **Prototype:** something runs, with known limitations.
|
||||
- **Usable:** documented setup and checks support its stated purpose.
|
||||
- **Archived:** retained for reference; active maintenance is not implied.
|
||||
|
||||
## Entry format
|
||||
|
||||
`[Project name](../experiments/project-name/README.md) — What it does. Status: prototype. Try it: see its README.`
|
||||
|
||||
Replace the example path with a real project before adding an entry.
|
||||
Reference in new issue
Block a user