Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/issue-templates-forms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug report
description: Report something that does not work as expected
labels: ["bug"]
body:
- type: textarea
id: what-happened
attributes:
label: What happened
description: What you did, what you expected, and what happened instead.
validations:
required: true
- type: input
id: version
attributes:
label: Relay version
description: Shown in the start-up banner.
placeholder: v3.15.3
validations:
required: true
- type: dropdown
id: deployment
attributes:
label: Deployment
options:
- docker compose
- standalone
- railway
- other
validations:
required: true
- type: dropdown
id: os
attributes:
label: OS
options:
- Linux
- macOS
- Windows
- other
validations:
required: true
- type: input
id: nips
attributes:
label: NIPs involved
description: If you know which.
placeholder: NIP-42, NIP-77
- type: textarea
id: logs
attributes:
label: Logs
description: The part of the log around the problem.
render: shell
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
placeholder: |
1. Run command '...'
2. See error
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Screenshots, settings, anything else that helps.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Report a security vulnerability
url: https://github.com/cameri/nostream/security/advisories/new
about: Please do not open a public issue for a vulnerability. Report it privately; SECURITY.md lists the supported versions.
- name: Ask in the development chat
url: https://t.me/nostream_dev
about: Questions about running or deploying nostream, and talk with other operators and contributors.
- name: Discuss the Nostr protocol
url: https://t.me/nostr_protocol
about: Questions about the protocol and the NIPs themselves, rather than about nostream.
- name: Visit the website
url: https://ema.tnsor.network
about: The nostream website, with an overview of the project.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Documentation
description: Something in the docs, README or website is missing, wrong or unclear
labels: ["documentation"]
body:
- type: input
id: location
attributes:
label: Where
description: The file or page, for example CONFIGURATION.md or a link to the website.
validations:
required: true
- type: textarea
id: problem
attributes:
label: What is missing, wrong or unclear
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested wording
description: Optional, if you already know what it should say.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest an idea for this project
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
**Pledge**
If the feature or idea is implemented or resolved to your satisfaction, please consider making a small monetary donation to support the continued development and independence of this project. To help the maintainers gauge on where to focus their effort, please include the amount of your pledge. A wallet address or Lightning invoice will be provided once the feature is complete.
- type: textarea
id: problem
attributes:
label: Problem
description: What are you trying to do, and what is in the way?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description: What you would like to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
- type: input
id: pledge
attributes:
label: Pledge amount
description: Optional. The amount you would pledge, with its unit.
placeholder: 50000 sats
- type: textarea
id: context
attributes:
label: Additional context
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/security_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Security report
about: Read this before reporting a security problem
labels: security
---

**Do not describe a vulnerability in this issue.** Issues are public.

Report vulnerabilities privately through GitHub's private vulnerability reporting instead:
https://github.com/cameri/nostream/security/advisories/new

`SECURITY.md` lists the versions that receive security fixes and what to include in a report.

Use this template only for a security question or a hardening suggestion that exposes nothing an attacker could use.
3 changes: 3 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ jobs:
# test/unit/scripts/deploy-with-retry.spec.ts runs the deploy
# script, so a change to it must run the suite that asserts on it.
- '.github/scripts/**'
# test/unit/ci/issue-templates.spec.ts reads these templates, so a
# template-only change must run the suite that asserts on them.
- '.github/ISSUE_TEMPLATE/**'

commit-lint:
name: Lint commits
Expand Down
Loading
Loading