Skip to content

Reason Network: your team's coding agents, talking to each other. The engine behind `reason network`.

Ready for contributors

Lars Talian7e021f75258e
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
new file mode 100644
index 0000000..b060ee9
--- /dev/null
+++ b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# The one-time rustfmt pass. git blame skips it with: git config blame.ignoreRevsFile .git-blame-ignore-revs
+bf9cc13f6fa12abde6ebf6b2f3f4dd739f137a6f
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
new file mode 100644
index 0000000..da6a374
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,21 @@
+name: Bug
+description: Something in tincan doesn't work
+labels: [bug]
+body:
+ - type: textarea
+ attributes:
+ label: What happened, and what you expected
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: tincan doctor
+ description: The output of `tincan doctor` on the machine with the problem (and the other machine, if it's about two).
+ render: text
+ - type: input
+ attributes:
+ label: Setup
+ description: tincan version (`tincan --version`), OS, and the coding agents involved.
+ placeholder: tincan 0.9.0, macOS 15, Claude Code and Codex
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..6b5f1c6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,4 @@
+contact_links:
+ - name: Questions and ideas
+ url: https://github.com/larstalian/tincan/discussions
+ about: Ask, or share an idea before building it.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..4ab2ad9
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,34 @@
+# Contributing
+
+Thanks for helping. tincan tries to stay small and to just work: a change that removes code or a step is worth more
+than a new option. For anything bigger than a fix, open an [issue](https://github.com/larstalian/tincan/issues) or a
+[discussion](https://github.com/larstalian/tincan/discussions) first so we can agree on the shape.
+[Good first issues](https://github.com/larstalian/tincan/labels/good%20first%20issue) are a place to start, and
+[DESIGN.md](DESIGN.md) explains how the pieces fit.
+
+## Build and test
+
+```sh
+cargo fmt && cargo clippy --all-targets -- -D warnings && cargo test
+cargo build && python3 tests/e2e/two_machines.py # two machines over iroh (needs internet)
+python3 tests/e2e/hooks.py && python3 tests/e2e/guided.py
+```
+
+The e2e tests start their own daemons with their own `TINCAN_HOME`, so they leave an installed tincan alone. Run
+them from a plain terminal: inside a Claude Code session, two_machines.py also delivers its test messages into that
+session.
+
+## Pull requests
+
+- One change per pull request, saying what it changes and why. CI runs fmt, clippy and the tests on Linux, macOS and
+ Windows.
+- Match the code around you: plain names, few comments, and comments that say why.
+- Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
+ as defined in the Apache-2.0 license, shall be dual licensed as MIT OR Apache-2.0, without any additional terms or
+ conditions.
+
+Security issues go through private reporting instead: see [SECURITY.md](SECURITY.md).
+
+## Releasing
+
+Push a `v*` tag. A tag with a dash (`v1.2.0-rc.1`) makes a test release that installs and auto-updates never pick.
diff --git a/README.md b/README.md
index 8193cfd..f0e8dc6 100644
--- a/README.md
+++ b/README.md
@@ -84,12 +84,7 @@ tincan setup --remove && tincan leave && rm -rf ~/.tincan ~/.local/bin/tincan
On Windows, in PowerShell: `tincan setup --remove; tincan leave; Remove-Item -Recurse -Force ~\.tincan, ~\.local\bin\tincan*`
-## Development
+## Contributing
-```sh
-cargo test
-cargo build && python3 tests/e2e/two_machines.py # two machines over iroh (needs internet)
-python3 tests/e2e/hooks.py && python3 tests/e2e/guided.py
-```
-
-Push a `v*` tag to release. Licensed MIT OR Apache-2.0.
+Issues, ideas and pull requests are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md), or ask in
+[Discussions](https://github.com/larstalian/tincan/discussions). Licensed MIT OR Apache-2.0.
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..3f98a41
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,14 @@
+# Security
+
+Please report vulnerabilities privately through
+[GitHub's private reporting](https://github.com/larstalian/tincan/security/advisories/new), not in a public issue.
+Say what an attacker can do and how to reproduce it.
+
+What matters most:
+
+- Someone outside a team joining it, reading its messages or sessions, or sending into it.
+- A team member speaking for another person or machine.
+- Another local user or process talking to the daemon, or posing as it.
+- A message making an agent do more than its user would see in the `<tincan-message>` block.
+
+Fixes ship in a new release, which installs pick up through auto-update.