docs: a code of conduct, issue and pull request templates, and Discussions linked from the README (#237)

The README gains badges, a Community section and a current status: the
network has now run across separate machines, and nodes serve browsers
and keep several model providers.
This commit was merged in pull request #237.
This commit is contained in:
2026-10-14 18:49:16 +03:00
committed by GitHub
parent 5ca2b5ec9b
commit 377ed2ce91
7 changed files with 117 additions and 2 deletions
+46
View File
@@ -0,0 +1,46 @@
name: Something is broken
description: Sisyphus did something it should not, or did not do something it should.
labels: [bug]
body:
- type: textarea
id: what
attributes:
label: What happened
description: What you did, what you expected, and what happened instead. Paste any error exactly.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: How to make it happen again
placeholder: |
1. sisyphusd run --coordinator ...
2. sisyphusd submit primes ...
- type: dropdown
id: part
attributes:
label: Which part
multiple: true
options:
- The node (sisyphusd)
- The desktop app
- The planner or models
- The MCP server or skill
- Storage or IPFS
- Installing or building
- type: input
id: version
attributes:
label: Version or commit
description: "`sisyphusd version`, or the commit you built from."
- type: input
id: system
attributes:
label: System
placeholder: Windows 11, RTX 4050, Ollama 0.21
- type: textarea
id: logs
attributes:
label: Logs
description: The node's output around the problem. Remove anything private first.
render: text
+11
View File
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/sisyphus-network/Sisyphus/discussions/categories/q-a
about: How to run a node, lend a machine, or use the desktop app. Questions get answered in Discussions.
- name: Share an idea
url: https://github.com/sisyphus-network/Sisyphus/discussions/categories/ideas
about: Something Sisyphus could do. Ideas start in Discussions and become issues once there is a plan.
- name: Report a vulnerability
url: https://github.com/sisyphus-network/Sisyphus/security/policy
about: Please report security problems privately, not in a public issue.
+23
View File
@@ -0,0 +1,23 @@
name: A planned piece of work
description: Something to build, once it has been talked through. Open ideas belong in Discussions first.
labels: [enhancement]
body:
- type: textarea
id: why
attributes:
label: Why
description: What someone cannot do today, or what goes wrong.
validations:
required: true
- type: textarea
id: what
attributes:
label: What
description: What would be built, and how we will know it works.
validations:
required: true
- type: input
id: discussion
attributes:
label: Discussion
description: A link to where this was talked through, if anywhere.
+11
View File
@@ -0,0 +1,11 @@
## What and why
<!-- What this changes, and the issue it closes: "Closes #N". -->
## How it was checked
<!-- The tests added, and anything run by hand: on which machines, with what result. -->
- [ ] `make cover` passes (every statement tested) for daemon changes
- [ ] `npm run typecheck`, `npm test` and `npm run build` pass for desktop changes
- [ ] The README, `apps/sisyphusd/README.md` and `docs/` say what changed
+9
View File
@@ -0,0 +1,9 @@
# Code of conduct
Sisyphus adopts the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as its code of conduct. It applies in the repository, its issues, pull requests and discussions, and wherever someone speaks for the project.
In short: be considerate, assume good faith, criticise work and not people, and leave room for those who are new. Harassment, personal attacks and unwelcome sexual attention are not accepted in any form.
## Reporting
If someone's conduct concerns you, tell a maintainer privately: [@rvnminers-A-and-N](https://github.com/rvnminers-A-and-N) or [@excho0](https://github.com/excho0). Reports are kept confidential. The maintainers decide what happens, following the Covenant's [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines), from a private word up to a ban from the project.
+1 -1
View File
@@ -1,6 +1,6 @@
# Contributing to Sisyphus
Sisyphus is an early prototype built in the open. Issues, questions and pull requests are welcome.
Sisyphus is an early prototype built in the open. Issues, questions and pull requests are welcome. Questions and early ideas go to [Discussions](https://github.com/sisyphus-network/Sisyphus/discussions); bugs and planned work go to issues. Everyone taking part follows the [code of conduct](CODE_OF_CONDUCT.md).
## Before you start
+16 -1
View File
@@ -4,6 +4,13 @@
<h1 align="center">Sisyphus</h1>
<p align="center">
<a href="https://github.com/sisyphus-network/Sisyphus/actions/workflows/ci.yml"><img src="https://github.com/sisyphus-network/Sisyphus/actions/workflows/ci.yml/badge.svg?branch=dev" alt="CI" /></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="Apache 2.0 license" /></a>
<a href="https://github.com/sisyphus-network/Sisyphus/discussions"><img src="https://img.shields.io/github/discussions/sisyphus-network/Sisyphus" alt="Discussions" /></a>
<a href="https://github.com/sisyphus-network/Sisyphus/issues/23"><img src="https://img.shields.io/badge/roadmap-%2323-8a2be2" alt="Roadmap" /></a>
</p>
**Sisyphus is a decentralized network for useful compute.** Independent participants contribute CPU and GPU capacity, and users and AI agents submit computational work to the network. Its planned economic layer uses SISY to coordinate incentives, supply, and demand.
AI makes the network easier to use: describe a problem, and Sisyphus can plan the work, find suitable capacity, coordinate execution, inspect the results, and decide what to compute next.
@@ -244,7 +251,7 @@ The development shell includes Go, gopls, Delve, lint tools, Protocol Buffer gen
## Project status
Sisyphus is an early prototype. The network loop works without AI: a coordinator splits a job, workers on other nodes run the tasks, and the results are combined. Everything so far has run on one machine as separate processes; it has not yet been tried across physically separate machines.
Sisyphus is an early prototype. The network loop works without AI: a coordinator splits a job, workers on other nodes run the tasks, and the results are combined. It has run across physically separate machines on a home network, a Linux server and a Windows laptop with a graphics card, splitting a job between them and serving a language model from the card ([#18](https://github.com/sisyphus-network/Sisyphus/issues/18), [#87](https://github.com/sisyphus-network/Sisyphus/issues/87)).
**Working today**, in `sisyphusd`, written in Go:
@@ -272,6 +279,8 @@ Sisyphus is an early prototype. The network loop works without AI: a coordinator
- Jobs made of steps, each a job of its own that can use the results of those before it.
- Opt-in verification by replication: a job can ask that each of its tasks be run by several different workers and take a result only when they agree. A worker that returns something else is outvoted and named. It is for deterministic work, and does not stop workers that agree to lie. With spot checks only a share of the tasks, picked at random, is verified, and a worker that is caught has its other tasks in the job verified after all. A coordinator can count workers at one address as one, and can check a share of any job's tasks by running them again itself, which needs no second worker.
- The node's local API over Connect and gRPC-Web as well as gRPC, so that a page in a browser can use it.
- The desktop app's interface served by a node to a browser, which is paired with the node once by a one-time code and can be revoked device by device.
- Several named model providers kept by a node, each with its own key, which never leaves the node.
- A desktop app that shows a node and its pool, plans with it and admits or removes workers, packaged with the logo as a Windows installer, a macOS disk image and a Linux AppImage.
- A first real workload, `transcode`: a video is cut into stretches, encoded by ffmpeg on different workers, and joined.
- Container images as jobs: a worker whose owner allows it runs any image, one copy for each task, with its output stored and its log followed live.
@@ -284,6 +293,12 @@ Try it with `make demo`, or see [Trying it](#trying-it) below. [`apps/sisyphusd/
Two things in this section go beyond what the sections above describe and are still open for discussion: the choice of Go ([#1](https://github.com/sisyphus-network/Sisyphus/issues/1)), and building storage on IPFS formats while V0 lists IPFS as out of scope ([#25](https://github.com/sisyphus-network/Sisyphus/issues/25)).
## Community
- **[Discussions](https://github.com/sisyphus-network/Sisyphus/discussions)**: questions, ideas, and what you have run on a pool.
- **[Issues](https://github.com/sisyphus-network/Sisyphus/issues)**: bugs and planned work. The [board](https://github.com/orgs/sisyphus-network/projects/1) shows what is in progress.
- **[Contributing](CONTRIBUTING.md)**, the [code of conduct](CODE_OF_CONDUCT.md), and [reporting a vulnerability](SECURITY.md).
## License
Sisyphus is licensed under the [Apache License, Version 2.0](LICENSE). Contributions are accepted under the same license.