vrr/Pulse
2
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-10-02 20:29:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 17

Align contributor bug guidance with safe incident intake

Browse source 
The contributor guide still demanded reproduction steps and a running image even when an install never started or another attempt could cause an outage. Match the current issue forms: accept the original sequence, attempted release, installer provenance and only safely collected redacted evidence.

Contract-Neutral: Contributor reporting guidance only; no installation, release, or runtime contract change.
Change-source: pulse-maintainer
This commit is contained in:
pulse-triage[bot] 2026-09-29 19:43:18 +01:00
parent f7a7456d03
commit 6a77d1b007
1 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -15,8 +15,10 @@ and installer tooling.
## What To Open
- Bug reports: use the bug report issue form and include exact reproduction
steps, Pulse version, installation type, and any relevant logs or diagnostics.
- Bug reports: use the bug report issue form and describe the original sequence,
the version on the affected running instance (or the version or release asset
attempted if installation never completed), the installation type, and any
relevant, safely collected evidence. A second reproduction is not required.
- Feature requests: open an issue describing the problem you want solved, the
workflow you are trying to improve, and any constraints that matter.
- Questions and support requests: use GitHub Discussions when you need help,
@ -37,10 +39,18 @@ and installer tooling.
## How To Make An Issue Useful
- Search existing issues before opening a new one.
- Keep reproduction steps minimal and exact.
- State the Pulse version and image or package you are actually running.
- Include screenshots, logs, API output, or diagnostics when they clarify the
problem.
- Describe what happened before the failure. Do not repeat an action just to
produce steps if it could cause data loss, an outage, duplicate changes, or
excessive notifications; say why you have not repeated it instead.
- State the version on the affected running instance. If Pulse never started,
give the attempted version or release asset (or say "unknown") and identify
the installer or helper when known. Include an image tag or digest only for a
running container, not for a bare-metal or LXC install.
- Include screenshots, redacted logs, API output, or diagnostics when they
clarify the problem. If Pulse is running and it is safe to collect, use
`Settings -> Diagnostics -> Export for GitHub (sanitized)` for connection or
data failures. Never paste credentials, tokens, private keys, or a command
line containing them into an issue.
- Lead with one primary bug or operator outcome. If the context also exposes
another actionable topic, put it in the issue form's dedicated field. Triage
will preserve it with a linked disposition; you do not need to refile text