Skip to content

Commit 40b982b

Browse files
committed
chore(repo): update issue templates and add security policy
1 parent 570d675 commit 40b982b

4 files changed

Lines changed: 120 additions & 12 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 75 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,93 @@ body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to fill out this bug report!
9+
Thanks for the report. The more context (version, environment, **expected vs actual**), the faster we can reproduce and fix.
10+
- type: input
11+
id: evlog_version
12+
attributes:
13+
label: evlog version
14+
description: "From `package.json` or `npm ls evlog` (e.g. 1.2.3)."
15+
placeholder: e.g. 0.45.0
16+
validations:
17+
required: true
18+
- type: input
19+
id: runtime
20+
attributes:
21+
label: Runtime & OS
22+
description: "Bun or Node version, and OS (e.g. `bun 1.2.3` / macOS 15)."
23+
placeholder: e.g. bun 1.2.3, Ubuntu 24.04
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: integration
28+
attributes:
29+
label: Framework / integration
30+
description: Where you use evlog (pick the closest match).
31+
options:
32+
- Nuxt
33+
- Nitro
34+
- Vite
35+
- Next.js
36+
- TanStack Start
37+
- Hono
38+
- Fastify
39+
- Express
40+
- Elysia
41+
- NestJS
42+
- SvelteKit
43+
- React Router
44+
- Cloudflare Workers
45+
- No framework (Node/Bun only)
46+
- Other
47+
- Not sure
48+
validations:
49+
required: true
50+
- type: input
51+
id: adapter
52+
attributes:
53+
label: Adapter or drain (optional)
54+
description: "If the bug involves shipping logs (Axiom, Datadog, Sentry, file system, etc.), name it here."
55+
placeholder: e.g. axiom, otlp, console
56+
validations:
57+
required: false
1058
- type: textarea
1159
id: description
1260
attributes:
1361
label: Description
14-
description: Describe the bug
62+
description: What went wrong, in a few sentences.
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: expected
67+
attributes:
68+
label: Expected behavior
69+
description: What you expected to happen.
70+
validations:
71+
required: true
72+
- type: textarea
73+
id: actual
74+
attributes:
75+
label: Actual behavior
76+
description: What happened instead.
1577
validations:
1678
required: true
1779
- type: textarea
1880
id: reproduction
1981
attributes:
2082
label: Reproduction
21-
description: Steps to reproduce the behavior or a minimal reproduction
83+
description: Steps to reproduce, or a link to a minimal repository / gist. If you cannot isolate it, say what you already tried.
84+
placeholder: |
85+
1. …
86+
2. …
87+
88+
Or: minimal repo: https://github.com/…
2289
validations:
2390
required: true
2491
- type: textarea
2592
id: logs
2693
attributes:
27-
label: Logs
28-
description: |
29-
Include any relevant logs or error messages
94+
label: Logs or structured output (optional)
95+
description: Relevant log lines, wide-event JSON, or stack traces. Redact secrets and tokens.
96+
placeholder: Paste logs or one representative JSON event
97+
validations:
98+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3+
- name: Read the documentation
4+
url: https://evlog.dev
5+
about: Guides, API reference, and framework setup.
36
- name: Ask a question
4-
url: https://github.com/your-org/your-module/discussions/new?category=q-a
5-
about: Please ask and answer questions here.
7+
url: https://github.com/HugoRCD/evlog/discussions/new?category=q-a
8+
about: Q&A and usage help in GitHub Discussions.
9+
- name: Report a security issue
10+
url: https://github.com/HugoRCD/evlog/security/advisories/new
11+
about: Do not file public issues for security vulnerabilities — use a private GitHub security advisory.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,35 @@ description: Suggest an idea for this project
33
title: "[feature] "
44
labels: [enhancement]
55
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Brainstorming or “what if?” ideas** are welcome in [Discussions](https://github.com/HugoRCD/evlog/discussions) first. Use this template when you have a **concrete** proposal the maintainers can evaluate.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem or motivation
14+
description: What user or system problem does this solve? Why is it important?
15+
validations:
16+
required: true
617
- type: textarea
718
id: description
819
attributes:
9-
label: Description
10-
description: Describe the feature you would like to see
20+
label: Proposed feature
21+
description: Describe the behavior, API, or experience you want (be specific).
1122
validations:
1223
required: true
1324
- type: textarea
1425
id: solution
1526
attributes:
16-
label: Proposed Solution
17-
description: Describe how you would implement this feature (optional)
27+
label: Possible implementation (optional)
28+
description: If you have ideas on API shape, defaults, or integration points, outline them here.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives you’ve considered (optional)
35+
description: Workarounds, other tools, or smaller changes that would partly help.
1836
validations:
1937
required: false

SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security
2+
3+
## Reporting a vulnerability
4+
5+
**Please do not** open a public issue or discussion for security-sensitive bugs.
6+
7+
Use **[GitHub Security Advisories (private report)](https://github.com/HugoRCD/evlog/security/advisories/new)** so maintainers can assess and release a fix responsibly.
8+
9+
Include:
10+
11+
- A clear description and impact
12+
- Affected evlog version(s) and, if relevant, the framework integration (Nuxt, Nitro, etc.)
13+
- Steps to reproduce or a minimal code sample, when safe to share
14+
15+
We will triage reports as soon as we can. Thank you for helping keep users safe.

0 commit comments

Comments
 (0)