mirror of
https://github.com/navidrome/navidrome.git
synced 2026-11-18 08:08:45 +01:00
* docs(contributing): propose updated contribution policy Draft proposal for maintainer review. Rewrite the contribution guide around prior scope agreement, personal review, AI disclosure and maintainability, while keeping the commit conventions and DCO sign-off. Add AI use and review items to the PR template, keeping its headings. Simplify the bug form so only what happened, the version and the Code of Conduct are required, and it no longer asks for an upgrade or a duplicate-search attestation. Update the selector text and point README feature requests to Discussions. Keep the pull-requests anchor because the stale workflow links to it. Signed-off-by: Deluan <deluan@navidrome.org> * docs(contributing): allow AI-assisted PR text and review replies Let contributors use AI tools to draft, edit, or translate PR explanations and review replies, as long as they review the final text, agree with it, and take responsibility for it. The PR template description hint now says the same instead of asking for the contributor's own words. Signed-off-by: Deluan <deluan@navidrome.org> * docs(contributing): route closed-issue regressions and no-agreement PRs The bug form told reporters to add details to a matching report, but the lock workflow locks inactive issues and asks for a new issue instead. It now says to use a matching open report, or open a new one that links a closed issue. The PR template and guide only offered the small-change exception when prior agreement isn't needed, which doesn't fit translation updates. Both now ask contributors to explain why agreement isn't needed. Signed-off-by: Deluan <deluan@navidrome.org> * docs(contributing): ask contributors to be mindful of the maintainer's time Add the request to the end of the communication paragraph in the guide and to the PR template's description hint. Signed-off-by: Deluan <deluan@navidrome.org> * docs(issues): require reproducing bugs on the latest release Restore a required checkbox in the bug form, placed before the version field: "I'm using the latest Navidrome release and can reproduce the issue on it." Drop the version help sentence that said upgrading isn't required, since it now contradicts the checkbox. Signed-off-by: Deluan <deluan@navidrome.org> * docs(issues): turn the bug form search guidance into a checkbox The long intro paragraph was easy to skip. It now only thanks the reporter and links private security reporting. A required checkbox, grouped with the latest-release one at the top, confirms the reporter searched open and closed issues. The "What happened" help asks reporters to link a matching closed issue. The steps help now says "If it happens only sometimes" instead of mentioning problems that can't be reproduced, so it no longer conflicts with the required reproduction checkbox. Signed-off-by: Deluan <deluan@navidrome.org> * docs(pr-template): ask for AI use with Yes and No checkboxes Replace the free-text "Yes / No" line with two checkboxes. Contributors tick exactly one, so empty boxes clearly mean the question wasn't answered. Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
79 lines
3.7 KiB
YAML
79 lines
3.7 KiB
YAML
name: Bug report
|
|
description: Report something that is not working as expected. You do not need to know the cause or how to fix it.
|
|
title: "[Bug]: "
|
|
labels: ["triage"]
|
|
#assignees:
|
|
# - deluan
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for reporting a problem. For a possible security vulnerability, use [private reporting](https://github.com/navidrome/navidrome/security/advisories/new).
|
|
- type: checkboxes
|
|
id: requirements
|
|
attributes:
|
|
label: "I confirm that:"
|
|
options:
|
|
- label: I have searched the existing [open and closed issues](https://github.com/navidrome/navidrome/issues?q=is%3Aissue) and found no matching open report.
|
|
required: true
|
|
- label: I'm using the latest Navidrome release and can reproduce the issue on it.
|
|
required: true
|
|
- type: textarea
|
|
id: what-happened
|
|
attributes:
|
|
label: What happened
|
|
description: Describe what you observed and how it affected you. Include any error message you saw. You do not need to diagnose the cause or suggest code changes. If a closed issue matches, link it here.
|
|
validations:
|
|
required: true
|
|
- type: input
|
|
id: version
|
|
attributes:
|
|
label: Navidrome version
|
|
description: Which Navidrome version or build are you using? If you cannot find it, enter 'not sure'. If you tried another version, mention whether the behavior changed.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected behavior and why
|
|
description: What did you expect, and why? If available, link documentation, an applicable API contract, or a previously working version. A personal expectation is useful context too; it does not by itself establish that the product should change. If you are unsure, say so.
|
|
validations:
|
|
required: false
|
|
- type: textarea
|
|
id: steps
|
|
attributes:
|
|
label: Steps to reproduce
|
|
description: List the steps, relevant settings, and how often the problem occurs. If it happens only sometimes, describe what was happening when you noticed it and what you have already tried.
|
|
validations:
|
|
required: false
|
|
- type: textarea
|
|
id: env
|
|
attributes:
|
|
label: Relevant environment
|
|
description: >-
|
|
Include only details relevant to this problem: server operating system, installation method, and the browser or client app with its version, if involved. Leave out details you do not know. Examples of installation methods: Docker, downloaded binary, package, or source build.
|
|
validations:
|
|
required: false
|
|
- type: textarea
|
|
id: config-logs
|
|
attributes:
|
|
label: Relevant configuration and logs
|
|
description: >-
|
|
Paste only the configuration settings or log excerpt related to this problem. Remove passwords, tokens, API keys, session cookies, private URLs, and identifying information before submitting. Debug logs are optional. If you cannot safely share an excerpt, explain what it shows instead. [Log guidance](https://www.navidrome.org/docs/faq/#-where-are-the-logs).
|
|
validations:
|
|
required: false
|
|
- type: textarea
|
|
id: additional-context
|
|
attributes:
|
|
label: Screenshots or additional context
|
|
description: Add screenshots, recordings, links, or other observations that help explain the problem. Remove private information from attachments as well.
|
|
validations:
|
|
required: false
|
|
- type: checkboxes
|
|
id: terms
|
|
attributes:
|
|
label: Code of Conduct
|
|
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/navidrome/navidrome/blob/master/CODE_OF_CONDUCT.md).
|
|
options:
|
|
- label: I agree to follow Navidrome's Code of Conduct
|
|
required: true
|