Skip to content

Commit 4b57d11

Browse files
committed
docs: SECURITY.md, issue templates, profile README
Made-with: Cursor
1 parent 7965344 commit 4b57d11

5 files changed

Lines changed: 139 additions & 11 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Bug Report
2+
description: Report a bug in an effectorHQ package
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting a bug! Please fill out the sections below.
9+
- type: input
10+
id: package
11+
attributes:
12+
label: Package
13+
description: Which @effectorhq package is affected?
14+
placeholder: "@effectorhq/core"
15+
validations:
16+
required: true
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Version
21+
description: What version are you using?
22+
placeholder: "1.0.0"
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: What happened? What did you expect to happen?
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: reproduction
34+
attributes:
35+
label: Steps to reproduce
36+
description: Minimal steps to reproduce the bug
37+
placeholder: |
38+
1. Run `npx @effectorhq/core validate .`
39+
2. See error...
40+
validations:
41+
required: true
42+
- type: input
43+
id: node-version
44+
attributes:
45+
label: Node.js version
46+
placeholder: "22.0.0"
47+
- type: input
48+
id: os
49+
attributes:
50+
label: Operating system
51+
placeholder: "macOS 15.3"

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions & Discussions
4+
url: https://github.com/effectorHQ/.github/discussions
5+
about: Ask questions, share ideas, or discuss effectorHQ
6+
- name: Security vulnerabilities
7+
url: https://github.com/effectorHQ/.github/security/policy
8+
about: Report security vulnerabilities privately
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature Request
2+
description: Suggest a feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We'd love to hear your ideas! Describe the feature and why it would be useful.
9+
- type: input
10+
id: package
11+
attributes:
12+
label: Package
13+
description: Which package does this relate to? (or "new" for a new package)
14+
placeholder: "@effectorhq/core"
15+
- type: textarea
16+
id: problem
17+
attributes:
18+
label: Problem
19+
description: What problem does this solve? What's the use case?
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed solution
26+
description: How would you like this to work?
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives considered
33+
description: What alternatives have you considered?

‎SECURITY.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | --------- |
7+
| 1.x.x | ✅ Yes |
8+
| < 1.0 | ❌ No |
9+
10+
## Reporting a Vulnerability
11+
12+
**Please do not open public issues for security vulnerabilities.**
13+
14+
Report vulnerabilities privately via GitHub Security Advisories:
15+
16+
👉 [Report a vulnerability](https://github.com/effectorHQ/.github/security/advisories/new)
17+
18+
Or email: **security@effectorhq.dev** *(monitored, response within 72 hours)*
19+
20+
### What to include
21+
22+
- Package name and version affected
23+
- Description of the vulnerability
24+
- Steps to reproduce
25+
- Potential impact
26+
- Any suggested fix (optional)
27+
28+
### What to expect
29+
30+
1. **Acknowledgement** within 72 hours
31+
2. **Assessment** within 7 days — we'll confirm scope and severity
32+
3. **Fix and disclosure** — we coordinate a release and CVE if applicable, then publish a security advisory
33+
34+
We follow [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) and will credit researchers who report valid vulnerabilities (unless you prefer to remain anonymous).
35+
36+
## Scope
37+
38+
All packages under the `@effectorhq` npm scope and repositories in the [effectorHQ GitHub organization](https://github.com/effectorHQ) are in scope.
39+
40+
Note: effectorHQ packages are **static analysis tools** — they parse and validate files but do not execute agent tools or make network requests at runtime. The primary threat surface is path traversal and malicious input in parsed files.

‎profile/README.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ We don't build the brain (that's the LLM). We don't build the body (that's the r
3131

3232
```bash
3333
# Get started in 30 seconds
34-
npm install @effectorhq/core # parse, validate, type-check, compile
35-
npx @effectorhq/create-effector my-skill # scaffold a new effector
36-
npx @effectorhq/skill-lint . # lint before you ship
34+
npm install @effectorhq/core # parse, validate, type-check, compile
35+
npx @effectorhq/create-effector my-skill # scaffold a new effector
36+
npx @effectorhq/skill-lint . # lint before you ship
37+
npx @effectorhq/studio # visual tool builder (browser UI)
38+
npx @effectorhq/graph spectrum # visualize the 36-type capability map
3739
```
3840

3941
Quick read: [Typed AI Agent Tools](https://github.com/effectorHQ/docs/blob/main/blog/typed-ai-agent-tools.md) · [v1.0 release announcement](https://github.com/effectorHQ/.github/discussions/8)
@@ -75,6 +77,7 @@ The core thesis: AI agent capabilities need types. Today you chain two skills an
7577
| Project | What it does | Status |
7678
|---------|-------------|--------|
7779
| [`create-effector`](https://github.com/effectorHQ/create-effector) | `npx @effectorhq/create-effector` — scaffold any Effector type in seconds | [![npm](https://img.shields.io/npm/v/@effectorhq/create-effector?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/create-effector) |
80+
| [`studio`](https://github.com/effectorHQ/studio) | **Visual tool builder** — `npx @effectorhq/studio` opens a browser UI with live TOML/SKILL preview, 4-target compilation, and one-click scaffold | [![npm](https://img.shields.io/npm/v/@effectorhq/studio?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/studio) |
7881
| [`linear-skill`](https://github.com/effectorHQ/linear-skill) | **Reference implementation** — production-ready skill, Grade A eval, zero lint errors | v1.0.0 |
7982
| [`cookbook`](https://github.com/effectorHQ/cookbook) | Real-world skill recipes: Docker, Jira, PostgreSQL, git worktrees | Examples |
8083

@@ -84,7 +87,7 @@ The core thesis: AI agent capabilities need types. Today you chain two skills an
8487
| Project | What it does | Status |
8588
|---------|-------------|--------|
8689
| [`effector-compose`](https://github.com/effectorHQ/effector-compose) | Build agent pipelines, type-check them, emit to any runtime · `npm i @effectorhq/compose` | [![npm](https://img.shields.io/npm/v/@effectorhq/compose?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/compose) |
87-
| [`effector-graph`](https://github.com/effectorHQ/effector-graph) | Capability graph visualization and path-finding · `npm i @effectorhq/graph` | [![npm](https://img.shields.io/npm/v/@effectorhq/graph?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/graph) |
90+
| [`effector-graph`](https://github.com/effectorHQ/effector-graph) | Capability graph + **Spectrum** polar visualization · `npx @effectorhq/graph spectrum` | [![npm](https://img.shields.io/npm/v/@effectorhq/graph?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/graph) |
8891
| [`openclaw-mcp`](https://github.com/effectorHQ/openclaw-mcp) | SKILL.md → MCP bridge — make skills work in Claude, Cursor, Windsurf · `npx @effectorhq/skill-mcp` | [![npm](https://img.shields.io/npm/v/@effectorhq/skill-mcp?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/skill-mcp) |
8992

9093
### Explore & Learn
@@ -96,13 +99,6 @@ The core thesis: AI agent capabilities need types. Today you chain two skills an
9699
| [`lobster-recipes`](https://github.com/effectorHQ/lobster-recipes) | Workflow pipelines: deploy-and-notify, daily-standup, PR-review-triage |
97100
| [`docs`](https://github.com/effectorHQ/docs) | Community guides: architecture, skill development, extension development |
98101

99-
### Prev.
100-
101-
| Project | What it does |
102-
|---------|-------------|
103-
| [`OpentheClaw`](https://github.com/effectorHQ/OpentheClaw) | One‑click SSH tunnel + Web login |
104-
| [`duckduckgo-api`](https://github.com/effectorHQ/duckduckgo-api) | DuckDuckGo‑based search proxy API for OpenClaw agents |
105-
106102
### Governance
107103

108104
| Document | Purpose |

0 commit comments

Comments
 (0)