Skip to content

Commit 36ae4ee

Browse files
docs: add community health docs and triage rubric (anomalyco#725)
1 parent 70aa46b commit 36ae4ee

5 files changed

Lines changed: 167 additions & 12 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Code of Conduct
2+
3+
## Our commitment
4+
5+
We are committed to making participation in the OpenWork community a harassment-free
6+
experience for everyone, regardless of age, body size, disability, ethnicity, sex
7+
characteristics, gender identity and expression, level of experience, education,
8+
socio-economic status, nationality, personal appearance, race, religion, or sexual
9+
identity and orientation.
10+
11+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
12+
inclusive, and healthy community.
13+
14+
## Our standards
15+
16+
Examples of behavior that contributes to a positive environment include:
17+
18+
- Demonstrating empathy and kindness toward other people.
19+
- Being respectful of differing opinions, viewpoints, and experiences.
20+
- Giving and gracefully accepting constructive feedback.
21+
- Taking responsibility and apologizing to those affected by our mistakes.
22+
- Focusing on what is best for the community.
23+
24+
Examples of unacceptable behavior include:
25+
26+
- The use of sexualized language or imagery and sexual attention or advances.
27+
- Trolling, insulting or derogatory comments, and personal or political attacks.
28+
- Public or private harassment.
29+
- Publishing others' private information without explicit permission.
30+
- Other conduct that could reasonably be considered inappropriate in a professional
31+
setting.
32+
33+
## Enforcement responsibilities
34+
35+
Project maintainers are responsible for clarifying and enforcing our standards of
36+
acceptable behavior and will take appropriate and fair corrective action in response
37+
to behavior they deem inappropriate, threatening, offensive, or harmful.
38+
39+
## Scope
40+
41+
This Code of Conduct applies within all community spaces, including GitHub issues,
42+
pull requests, discussions, and direct interactions in official OpenWork channels.
43+
44+
## Reporting
45+
46+
If you experience or witness unacceptable behavior, report it to
47+
`[email protected]` with as much context as possible.
48+
49+
All reports will be reviewed and investigated promptly and fairly.
50+
51+
## Attribution
52+
53+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1.
54+
55+
[homepage]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/

‎README.md‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[![Discord](https://img.shields.io/badge/discord-join-5865F2?logo=discord&logoColor=white)](https://discord.gg/VEhNQXxYMB)
22

33
# OpenWork
4-
> OpenWork helps you run your agents, skills, and MCP. It's an open-source alternative to Claude Cowork/Codex (desktop app).
54

5+
> OpenWork helps you run your agents, skills, and MCP. It's an open-source alternative to Claude Cowork/Codex (desktop app).
66
7-
87
## Core Philosophy
8+
99
- Local-first, cloud-ready: OpenWork runs on your machine in one click. Send a message instantly.
1010
- Composable: desktop app, WhatsApp/Slack/Telegram connector, or server. Use what fits, no lock-in.
1111
- Ejectable: OpenWork is powered by OpenCode, so everything OpenCode can do works in OpenWork, even without a UI yet.
@@ -15,10 +15,8 @@
1515
<img src="./app-demo.gif" alt="OpenWork demo" width="800" />
1616
</p>
1717

18-
1918
OpenWork is designed around the idea that you can easily ship your agentic workflows as a repeatable, productized process.
2019

21-
2220
## Alternate UIs
2321

2422
- **OpenCode Router (WhatsApp bot)**: a lightweight WhatsApp bridge for a running OpenCode server. Install with:
@@ -30,21 +28,22 @@ OpenWork is designed around the idea that you can easily ship your agentic workf
3028
- run: `openwork start --workspace /path/to/workspace --approval auto`
3129
- docs: [packages/orchestrator/README.md](./packages/orchestrator/README.md)
3230

33-
3431
## Quick start
32+
3533
Download the dmg here https://github.com/different-ai/openwork/releases (or install from source below)
3634

3735
## Why
3836

3937
Current CLI and GUIs for opencode are anchored around developers. That means a focus on file diffs, tool names, and hard to extend capabilities without relying on exposing some form of cli.
4038

4139
OpenWork is designed to be:
40+
4241
- **Extensible**: skill and opencode plugins are installable modules.
4342
- **Auditable**: show what happened, when, and why.
4443
- **Permissioned**: access to privileged flows.
4544
- **Local/Remote**: OpenWork works locally as well as can connect to remote servers.
4645

47-
## What’s Included
46+
## What’s Included
4847

4948
- **Host mode**: runs opencode locally on your computer
5049
- **Client mode**: connect to an existing OpenCode server by URL.
@@ -57,15 +56,14 @@ OpenWork is designed to be:
5756
- list installed `.opencode/skills` folders
5857
- install from OpenPackage (`opkg install ...`)
5958
- import a local skill folder into `.opencode/skills/<skill-name>`
60-
6159

62-
## Skill Manager
63-
<img width="1292" height="932" alt="image" src="https://github.com/user-attachments/assets/b500c1c6-a218-42ce-8a11-52787f5642b6" />
60+
## Skill Manager
6461

62+
<img width="1292" height="932" alt="image" src="https://github.com/user-attachments/assets/b500c1c6-a218-42ce-8a11-52787f5642b6" />
6563

6664
## Works on local computer or servers
67-
<img width="1292" height="932" alt="Screenshot 2026-01-13 at 7 05 16 PM" src="https://github.com/user-attachments/assets/9c864390-de69-48f2-82c1-93b328dd60c3" />
6865

66+
<img width="1292" height="932" alt="Screenshot 2026-01-13 at 7 05 16 PM" src="https://github.com/user-attachments/assets/9c864390-de69-48f2-82c1-93b328dd60c3" />
6967

7068
## Quick Start
7169

@@ -118,12 +116,11 @@ This lets you run agentic workflows, send prompts, and see progress entirely on
118116
- subscribe to SSE events(Server-Sent Events are used to stream real-time updates from the server to the UI.)
119117
- read todos and permission requests
120118

121-
122-
123119
## Folder Picker
124120

125121
The folder picker uses the Tauri dialog plugin.
126122
Capability permissions are defined in:
123+
127124
- `packages/desktop/src-tauri/capabilities/default.json`
128125

129126
## OpenPackage Notes
@@ -190,6 +187,21 @@ WEBKIT_DISABLE_COMPOSITING_MODE=1 openwork
190187
- If CI fails, classify failures in the PR body as either code-related regressions or external/environment/auth blockers.
191188
- Add new PRDs to `packages/app/pr/<name>.md` following the `.opencode/skills/prd-conventions/SKILL.md` conventions described in `AGENTS.md`.
192189

190+
Community docs:
191+
192+
- `CODE_OF_CONDUCT.md`
193+
- `SECURITY.md`
194+
- `SUPPORT.md`
195+
- `TRIAGE.md`
196+
197+
First contribution checklist:
198+
199+
- [ ] Run `pnpm install` and baseline verification commands.
200+
- [ ] Confirm your change has a clear issue link and scope.
201+
- [ ] Add/update tests for behavioral changes.
202+
- [ ] Include commands run and outcomes in your PR.
203+
- [ ] Add screenshots/video for user-facing flow changes.
204+
193205
## For Teams & Businesses
194206

195207
Interested in using OpenWork in your organization? We'd love to hear from you — reach out at [[email protected]](mailto:[email protected]) to chat about your use case.

‎SECURITY.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
OpenWork is under active development and we prioritize fixes on the latest release and
6+
the current `dev` branch.
7+
8+
## Reporting a vulnerability
9+
10+
Please do not open public GitHub issues for security vulnerabilities.
11+
12+
Instead, report vulnerabilities privately to:
13+
14+
15+
- Subject: `[OpenWork security] <short summary>`
16+
17+
Please include:
18+
19+
- A clear description of the issue
20+
- Reproduction steps or proof of concept
21+
- Impact assessment
22+
- Suggested remediation (if known)
23+
24+
## Response expectations
25+
26+
- We will acknowledge receipt within 3 business days.
27+
- We will provide an initial triage status within 7 business days.
28+
- We will share remediation or mitigation guidance as soon as available.
29+
30+
## Disclosure guidance
31+
32+
Please keep details private until a fix or mitigation is available and maintainers
33+
confirm public disclosure timing.

‎SUPPORT.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Support
2+
3+
## Where to ask for help
4+
5+
Use the right channel to get faster help:
6+
7+
- **Questions / usage help**: open a GitHub issue and mark it as a question.
8+
- **Bug reports**: use the Bug issue template.
9+
- **Feature requests**: use the Feature issue template.
10+
- **Security reports**: follow `SECURITY.md` and report privately.
11+
12+
## Before opening an issue
13+
14+
- Search existing issues to avoid duplicates.
15+
- Include exact OpenWork/OpenCode versions, OS, and reproduction steps.
16+
- Add logs/screenshots when possible.
17+
18+
## Maintainer triage
19+
20+
Maintainers use the rubric in `TRIAGE.md` to label and route issues.

‎TRIAGE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Issue Triage Rubric
2+
3+
This document defines how maintainers triage issues consistently.
4+
5+
## Core type labels
6+
7+
- `bug`: behavior does not match expected behavior.
8+
- `enhancement`: improvement to existing behavior.
9+
- `question`: support or usage request.
10+
11+
Apply exactly one core type label whenever possible.
12+
13+
## Contribution-oriented labels
14+
15+
- `good first issue`: small, well-scoped, low-risk, and has clear acceptance criteria.
16+
- `help wanted` or `help needed`: maintainers welcome external contributions.
17+
- `needs-info`: issue cannot be actioned until reporter provides missing details.
18+
19+
## Suggested triage flow
20+
21+
1. Confirm issue template fields are complete.
22+
2. Add a core type label (`bug`, `enhancement`, or `question`).
23+
3. Add scope/difficulty labels if helpful.
24+
4. Add `needs-info` when reproduction details are missing.
25+
5. Add `good first issue` or `help wanted/help needed` only when issue is ready to build.
26+
27+
## Closing guidance
28+
29+
Close as:
30+
31+
- `duplicate`: issue already tracked elsewhere.
32+
- `invalid`: report is not actionable or not a product issue.
33+
- `wontfix`: acknowledged but not planned.
34+
35+
When closing, include a short reason and a link to related issue/docs when available.

0 commit comments

Comments
 (0)