From 48b699ad6bd5f7e9ddc9cb4a7b51d3317c83d096 Mon Sep 17 00:00:00 2001 From: Joe Amditis Date: Fri, 16 Oct 2026 20:39:14 +0000 Subject: [PATCH] docs: establish public Stash project guide --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4f7496..700aa3b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ -# stash +# Stash -Playground for testing and ideas. \ No newline at end of file +A public playground for small experiments, useful tools, and ideas worth keeping. Maintained by [Joe Amditis](https://git.inference.coop/jamditis) on the Inference Cooperative’s Gitea. + +Stash gives unfinished ideas room to become useful. Each experiment should explain what it does, how to try it, and what remains uncertain. This repository starts with the project scaffolding; no applications or hosted demos are included yet. + +## Start here + +- Browse the [experiment index](docs/experiments.md). +- Read the [contribution guide](CONTRIBUTING.md) before adding something. +- Use [issues](https://git.inference.coop/jamditis/stash/issues) for ideas and reproducible problems. +- Submit changes through a [pull request](https://git.inference.coop/jamditis/stash/pulls). + +## Get a local copy + +```sh +git clone https://git.inference.coop/jamditis/stash.git +cd stash +git switch -c experiment/your-idea +``` + +There is no repository-wide install or build step. Each future experiment should document its own dependencies and commands. Browser sign-in does not configure terminal Git authentication. + +## Keep experiments self-contained + +Use a short, descriptive directory name under experiments/ when adding a project. Include a README with its purpose, status, setup, usage, checks, limitations, and sources or license notices. Add an entry to the experiment index so people can find it. Keep dependencies and generated output scoped to that project. + +Suggested statuses: idea, prototype, usable, or archived. Label examples and mock data clearly. A successful demo is not evidence of production readiness. + +## Working together + +Small, focused changes are easier to review. Describe what changed and why, include screenshots for visual work, and record the checks you actually ran. Draft pull requests are welcome for unfinished work. See [CONTRIBUTING.md](CONTRIBUTING.md) for the checklist. + +## Public by design + +Everything committed here is public. Use synthetic or explicitly approved public data. Keep credentials, personal archives, private correspondence, and internal work files out of commits and issues. The ignore rules are a convenience, not a security boundary. Review the staged diff before pushing. + +## Checks and automation + +This starter has no runtime dependencies and no automated CI configured. Issue and pull-request templates help document verification. Add CI alongside a real experiment once its commands and the co-op’s runner availability are confirmed. + +## License + +Original contributions to this repository use [Apache-2.0](LICENSE). Retain notices and applicable licenses for any third-party material; do not assume this license covers imported content.