Skip to content

Commit ef785fa

Browse files
dialupdisasterdialupdisaster
committed
chore: add project infrastructure and metadata
- Add npm/gh badges to README (version, downloads, stars, build, license) - Add license field to package.json - Add description, keywords, author, homepage, bugs, exports, publishConfig - Add SECURITY.md with vulnerability reporting policy - Add issue templates (bug report, feature request) - Add pull request template - Link issue templates to Discussions
1 parent 1d61445 commit ef785fa

7 files changed

Lines changed: 245 additions & 16 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Bug report
2+
description: Report something that isn't working correctly
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: A clear description of the bug
11+
placeholder: "When I..."
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: steps
17+
attributes:
18+
label: Steps to reproduce
19+
description: How can we reproduce this behavior?
20+
value: |
21+
1. Set 'OPENCODE_ENABLE_TELEMETRY' to '...'
22+
2. Run '...'
23+
3. Observe '...'
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected
29+
attributes:
30+
label: Expected behavior
31+
description: What did you expect to happen?
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: actual
37+
attributes:
38+
label: Actual behavior
39+
description: What actually happened?
40+
validations:
41+
required: true
42+
43+
- type: input
44+
id: version
45+
attributes:
46+
label: Plugin version
47+
description: What version of @devtheops/opencode-plugin-otel are you using?
48+
placeholder: "0.4.1"
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: config
54+
attributes:
55+
label: Configuration
56+
description: Your relevant environment variables or opencode.json config (redact sensitive values)
57+
render: shell
58+
59+
- type: textarea
60+
id: logs
61+
attributes:
62+
label: Relevant log output
63+
description: Paste any relevant logs (redact sensitive values)
64+
render: shell
65+
66+
- type: checkboxes
67+
id: checks
68+
attributes:
69+
label: Checklist
70+
options:
71+
- label: I have searched existing issues to ensure this hasn't been reported
72+
required: true
73+
- label: I have redacted any sensitive information (API keys, tokens, etc.)
74+
required: true

‎.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: Feature Requests
4+
url: https://github.com/DEVtheOPS/opencode-plugin-otel/discussions/categories/ideas
5+
about: Share and discuss ideas for new features
6+
- name: Questions & Help
7+
url: https://github.com/DEVtheOPS/opencode-plugin-otel/discussions/categories/q-a
8+
about: Ask the community for help

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Is your feature request related to a problem?
10+
description: A clear description of what problem you're trying to solve
11+
placeholder: "I'm always frustrated when..."
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: solution
17+
attributes:
18+
label: Describe the solution you'd like
19+
description: What would you like to happen?
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Describe alternatives you've considered
27+
description: Have you considered any alternative solutions or workarounds?
28+
29+
- type: dropdown
30+
id: telemetry-type
31+
attributes:
32+
label: Telemetry type
33+
description: Which type(s) of telemetry would this affect?
34+
multiple: true
35+
options:
36+
- Metrics
37+
- Logs/Events
38+
- Configuration
39+
- Other
40+
41+
- type: textarea
42+
id: context
43+
attributes:
44+
label: Additional context
45+
description: Any other context, screenshots, or examples
46+
47+
- type: checkboxes
48+
id: checks
49+
attributes:
50+
label: Checklist
51+
options:
52+
- label: I have searched existing issues and discussions for similar feature requests
53+
required: true
54+
- label: I have checked the changelog to see if this already exists
55+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
3+
<!-- A brief description of the changes in this PR -->
4+
5+
## Type of change
6+
7+
<!-- Mark the relevant option with an 'x' -->
8+
9+
- [ ] Bug fix (non-breaking change that fixes an issue)
10+
- [ ] New feature (non-breaking change that adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Refactoring (no functional changes)
14+
- [ ] Chore (dependency updates, etc.)
15+
16+
## Checklist
17+
18+
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) document
19+
- [ ] My code follows the style guidelines of this project
20+
- [ ] `bun run typecheck` passes with no errors
21+
- [ ] `bun test` passes with no errors
22+
- [ ] I have added tests that prove my fix is effective or that my feature works
23+
- [ ] I have updated the documentation accordingly
24+
- [ ] My commits follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
25+
26+
## Related issues
27+
28+
<!-- Link to any related issues, e.g., "Fixes #123" or "Relates to #456" -->
29+
30+
## Additional context
31+
32+
<!-- Any other context, screenshots, or information that might be helpful -->

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# opencode-plugin-otel
22

3+
[![npm version](https://img.shields.io/npm/v/@devtheops/opencode-plugin-otel.svg)](https://www.npmjs.com/package/@devtheops/opencode-plugin-otel)
4+
[![npm downloads](https://img.shields.io/npm/dm/@devtheops/opencode-plugin-otel.svg)](https://www.npmjs.com/package/@devtheops/opencode-plugin-otel)
5+
[![GitHub stars](https://img.shields.io/github/stars/DEVtheOPS/opencode-plugin-otel.svg)](https://github.com/DEVtheOPS/opencode-plugin-otel/stargazers)
6+
[![Build status](https://img.shields.io/github/actions/workflow/status/DEVtheOPS/opencode-plugin-otel/release-please.yml?branch=main)](https://github.com/DEVtheOPS/opencode-plugin-otel/actions/workflows/release-please.yml)
7+
[![License](https://img.shields.io/npm/l/@devtheops/opencode-plugin-otel.svg)](https://github.com/DEVtheOPS/opencode-plugin-otel/blob/main/LICENSE)
8+
39
An [opencode](https://opencode.ai) plugin that exports telemetry via OpenTelemetry (OTLP/gRPC), mirroring the same signals as [Claude Code's monitoring](https://code.claude.com/docs/en/monitoring-usage).
410

511
- [What it instruments](#what-it-instruments)

‎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+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 0.4.x | :white_check_mark: |
8+
| < 0.4 | :x: |
9+
10+
## Reporting a Vulnerability
11+
12+
If you discover a security vulnerability, please report it responsibly:
13+
14+
1. **Do not** open a public issue
15+
2. Email the maintainer at security@devtheops.com
16+
3. Include:
17+
- Description of the vulnerability
18+
- Steps to reproduce
19+
- Potential impact
20+
- Suggested fix (if any)
21+
22+
### What to Expect
23+
24+
- **Acknowledgment** within 48 hours
25+
- **Initial assessment** within 7 days
26+
- **Status updates** at least every 14 days until resolved
27+
- **Public disclosure** only after a fix is released
28+
29+
### Preferred Languages
30+
31+
English is preferred, but we will do our best to accommodate other languages.
32+
33+
Thank you for helping keep this project secure.

‎package.json‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,40 @@
11
{
2+
"name": "@devtheops/opencode-plugin-otel",
3+
"version": "0.4.1",
4+
"description": "OpenTelemetry telemetry plugin for opencode CLI",
5+
"keywords": [
6+
"opentelemetry",
7+
"otel",
8+
"telemetry",
9+
"opencode",
10+
"plugin",
11+
"observability"
12+
],
13+
"license": "MPL-2.0",
14+
"author": "DEVtheOPS",
15+
"homepage": "https://github.com/DEVtheOPS/opencode-plugin-otel#readme",
16+
"bugs": {
17+
"url": "https://github.com/DEVtheOPS/opencode-plugin-otel/issues"
18+
},
19+
"repository": {
20+
"type": "git",
21+
"url": "https://github.com/DEVtheOPS/opencode-plugin-otel.git"
22+
},
23+
"type": "module",
24+
"main": "src/index.ts",
25+
"module": "src/index.ts",
26+
"exports": {
27+
".": "./src/index.ts"
28+
},
29+
"files": [
30+
"src/"
31+
],
32+
"publishConfig": {
33+
"access": "public"
34+
},
35+
"scripts": {
36+
"typecheck": "tsc --noEmit"
37+
},
238
"dependencies": {
339
"@opencode-ai/plugin": "^1.2.23",
440
"@opencode-ai/sdk": "^1.2.23",
@@ -13,20 +49,5 @@
1349
},
1450
"devDependencies": {
1551
"@types/bun": "latest"
16-
},
17-
"files": [
18-
"src/"
19-
],
20-
"main": "src/index.ts",
21-
"module": "src/index.ts",
22-
"name": "@devtheops/opencode-plugin-otel",
23-
"repository": {
24-
"type": "git",
25-
"url": "https://github.com/DEVtheOPS/opencode-plugin-otel.git"
26-
},
27-
"scripts": {
28-
"typecheck": "tsc --noEmit"
29-
},
30-
"type": "module",
31-
"version": "0.4.1"
52+
}
3253
}

0 commit comments

Comments
 (0)