Skip to content

myyoda/principles-examples

Repository files navigation

STAMPED Principles — Examples

A companion website to the STAMPED paper, providing concrete examples of Self-containment, Tracking, Actionability, Modularity, Portability, Ephemerality, and Distributability for dataset version control.

Live site: https://myyoda.github.io/principles-examples/

Build locally: hugo server (requires Hugo extended)

How to contribute examples

We welcome contributions of new examples via pull requests. If you are new to the PR workflow, see GitHub's Creating a pull request from a fork guide.

Adding an example

  1. Create a new Markdown file under content/examples/, e.g. content/examples/my-example-slug.md.

  2. Fill in the front matter — every example needs these fields:

    ---
    title: "Short descriptive title"
    date: 2026-01-15
    description: "One-sentence description for metadata/SEO"
    summary: "Slightly longer summary shown in listings"
    tags: ["relevant", "keywords"]
    stamped_principles: ["S", "T", "A", "M", "P", "E", "D"]  # which apply
    fair_principles: ["F", "A", "I", "R"]                      # which apply
    instrumentation_levels: ["data-organization"]  # or: tool, workflow, pattern
    aspirations: ["reproducibility"]  # or: rigor, transparency, efficiency
    state: wip         # wip | uncurated-ai | final (omit for final)
    params:
      tools: ["git"]   # tools used in the example
      difficulty: "beginner"  # beginner | intermediate | advanced
      verified: false   # set true once commands have been tested
    ---
  3. Write the body: explain the problem, show the solution with concrete commands and code snippets, and connect it back to the STAMPED principles it demonstrates.

  4. Open a pull request against main.

Taxonomy values

Dimension Valid values
stamped_principles S T A M P E D
fair_principles F A I R
instrumentation_levels data-organization tool workflow pattern
aspirations reproducibility rigor transparency efficiency
state wip uncurated-ai final (or omit)
params.difficulty beginner intermediate advanced

About

Examples addendum for YODA/STAMPED principles paper

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors