Skip to content

Commit 8b526fc

Browse files
AnInsomniacyAnInsomniacy
committed
docs: add community and release guidance
1 parent f30dc82 commit 8b526fc

19 files changed

Lines changed: 1023 additions & 2 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
name: Bug Report
2+
description: Report a reproducible raria runtime, CLI, daemon, or API bug
3+
title: "[bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this form for reproducible product bugs in raria.
10+
Please search existing issues before opening a new one.
11+
12+
- type: input
13+
id: version
14+
attributes:
15+
label: raria version
16+
description: Output from `raria --version`, or the Git commit if built from source.
17+
placeholder: "raria 1.0.0"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: surface
23+
attributes:
24+
label: Affected surface
25+
options:
26+
- CLI single download
27+
- Daemon runtime
28+
- Native HTTP API
29+
- WebSocket event stream
30+
- Configuration
31+
- Persistence or restore
32+
- Release archive or binary
33+
- Documentation
34+
validations:
35+
required: true
36+
37+
- type: dropdown
38+
id: protocol
39+
attributes:
40+
label: Transfer type
41+
options:
42+
- HTTP or HTTPS
43+
- FTP or FTPS
44+
- SFTP
45+
- BitTorrent or magnet
46+
- Metalink
47+
- Multi-source or mirror failover
48+
- Not transfer-specific
49+
validations:
50+
required: true
51+
52+
- type: dropdown
53+
id: platform
54+
attributes:
55+
label: Platform
56+
options:
57+
- macOS arm64
58+
- macOS x86_64
59+
- Linux x86_64
60+
- Linux aarch64
61+
- Windows x86_64
62+
- Windows aarch64
63+
- Other
64+
validations:
65+
required: true
66+
67+
- type: input
68+
id: os-version
69+
attributes:
70+
label: OS version
71+
placeholder: "macOS 15.5, Ubuntu 24.04, Windows 11 24H2"
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: command
77+
attributes:
78+
label: Command or API request
79+
description: Include the exact command, route, request body, or integration call. Redact secrets.
80+
render: shell
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: config
86+
attributes:
87+
label: Relevant raria.toml or runtime options
88+
description: Include only the settings needed to reproduce the issue. Redact tokens, passwords, cookies, and private keys.
89+
render: toml
90+
91+
- type: textarea
92+
id: steps
93+
attributes:
94+
label: Steps to reproduce
95+
description: Write the shortest repeatable sequence that triggers the problem.
96+
placeholder: |
97+
1. Start `raria daemon ...`
98+
2. Create a task through `/api/v1/tasks`
99+
3. Pause the task through `/api/v1/tasks/{taskId}/pause`
100+
4. Observe the failure
101+
validations:
102+
required: true
103+
104+
- type: textarea
105+
id: expected
106+
attributes:
107+
label: Expected behavior
108+
description: Describe the native raria behavior you expected.
109+
validations:
110+
required: true
111+
112+
- type: textarea
113+
id: actual
114+
attributes:
115+
label: Actual behavior
116+
description: Describe what happened instead. Include exact error codes or lifecycle states when available.
117+
validations:
118+
required: true
119+
120+
- type: textarea
121+
id: logs
122+
attributes:
123+
label: Logs and evidence
124+
description: Attach concise logs, API responses, event messages, or checksums. Redact secrets and avoid uploading private downloaded content.
125+
render: text
126+
127+
- type: textarea
128+
id: verification
129+
attributes:
130+
label: Local verification
131+
description: Include any focused command already run, such as `cargo test -p raria-cli --test native_api_smoke`.
132+
render: shell
133+
134+
- type: checkboxes
135+
id: validations
136+
attributes:
137+
label: Validations
138+
options:
139+
- label: I searched existing issues and did not find the same bug.
140+
required: true
141+
- label: This report uses raria-native CLI, configuration, `/api/v1`, or `/api/v1/events` terminology.
142+
required: true
143+
- label: I did not include passwords, bearer tokens, cookies, private keys, or private downloaded content.
144+
required: true

‎.github/ISSUE_TEMPLATE/build_packaging.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Build or Packaging Issue
2+
description: Report a local build failure, release archive issue, or platform packaging problem
3+
title: "[build]: "
4+
labels: ["build"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this form for Cargo builds, CI, release archives, checksums, or platform-specific binary issues.
10+
Runtime download bugs belong in the bug report form.
11+
12+
- type: input
13+
id: version
14+
attributes:
15+
label: raria version or commit
16+
placeholder: "v1.0.0 or 0123456789abcdef"
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: build-path
22+
attributes:
23+
label: Build path
24+
options:
25+
- Local Cargo build
26+
- GitHub Actions CI
27+
- GitHub Actions release workflow
28+
- Downloaded release archive
29+
- Cross-compilation
30+
- Other
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: platform
36+
attributes:
37+
label: Platform
38+
options:
39+
- macOS arm64
40+
- macOS x86_64
41+
- Linux x86_64
42+
- Linux aarch64
43+
- Windows x86_64
44+
- Windows aarch64
45+
- Other
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: rust-version
51+
attributes:
52+
label: Rust version
53+
description: Output from `rustc --version`.
54+
placeholder: "rustc 1.85.0"
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: command
60+
attributes:
61+
label: Command
62+
description: Include the exact command or workflow step that failed.
63+
render: shell
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: output
69+
attributes:
70+
label: Failure output
71+
description: Include the relevant compiler, linker, packaging, archive, or checksum output.
72+
render: text
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: environment
78+
attributes:
79+
label: Environment details
80+
description: Include target triple, linker, OS image, shell, and any non-default Cargo or Rust flags.
81+
82+
- type: checkboxes
83+
id: validations
84+
attributes:
85+
label: Validations
86+
options:
87+
- label: I searched existing issues and did not find the same build or packaging problem.
88+
required: true
89+
- label: I included the exact command or workflow step that failed.
90+
required: true
91+
- label: I did not include local secrets, private paths that matter, or credential-bearing logs.
92+
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: Questions and integration help
4+
url: https://github.com/AnInsomniacy/raria/discussions
5+
about: Use GitHub Discussions for usage questions, integration design, and non-reproducible troubleshooting.
6+
- name: Security issue
7+
url: https://github.com/AnInsomniacy/raria/security/advisories/new
8+
about: Report suspected vulnerabilities privately instead of opening a public issue.

‎.github/ISSUE_TEMPLATE/crash_report.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Crash or Hang Report
2+
description: Report a crash, panic, deadlock, stuck daemon, or unrecoverable hang
3+
title: "[crash]: "
4+
labels: ["bug", "crash"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this form for crashes, panics, hangs, stuck shutdown, or daemon processes that stop responding.
10+
For security-sensitive crashes, use a private security advisory instead.
11+
12+
- type: input
13+
id: version
14+
attributes:
15+
label: raria version
16+
description: Output from `raria --version`, or the Git commit if built from source.
17+
placeholder: "raria 1.0.0"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: mode
23+
attributes:
24+
label: Runtime mode
25+
options:
26+
- CLI single download
27+
- Foreground daemon
28+
- Detached daemon
29+
- Native API integration
30+
- Release workflow or archive
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: platform
36+
attributes:
37+
label: Platform
38+
options:
39+
- macOS arm64
40+
- macOS x86_64
41+
- Linux x86_64
42+
- Linux aarch64
43+
- Windows x86_64
44+
- Windows aarch64
45+
- Other
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: os-version
51+
attributes:
52+
label: OS version
53+
placeholder: "macOS 15.5, Ubuntu 24.04, Windows 11 24H2"
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: command
59+
attributes:
60+
label: Command or API sequence
61+
description: Include the command or API sequence that caused the crash or hang. Redact secrets.
62+
render: shell
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: panic
68+
attributes:
69+
label: Panic, backtrace, or process state
70+
description: Include stderr, panic output, `RUST_BACKTRACE=1` output, process status, or shutdown behavior.
71+
render: text
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: task-state
77+
attributes:
78+
label: Task and session state
79+
description: Include task lifecycle, active protocol, session path, and whether restore was involved. Do not upload private session databases unless requested by a maintainer.
80+
render: text
81+
82+
- type: textarea
83+
id: repeatability
84+
attributes:
85+
label: Repeatability
86+
description: State whether the crash happens every time, intermittently, or only after long runtime.
87+
validations:
88+
required: true
89+
90+
- type: checkboxes
91+
id: validations
92+
attributes:
93+
label: Validations
94+
options:
95+
- label: I searched existing issues and did not find the same crash or hang.
96+
required: true
97+
- label: I included the shortest known command or API sequence that triggers the failure.
98+
required: true
99+
- label: I redacted bearer tokens, credentials, cookies, private keys, and private file paths where needed.
100+
required: true

0 commit comments

Comments
 (0)