diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 276ee42c..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Bug report -about: Create a bug report -title: '' -labels: bug, triage needed -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..fe12835a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,105 @@ +name: "Bug Report" +description: "Report a bug or unexpected behavior" +title: "[Bug]: " +type: "Bug" +labels: ["triage needed"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug! Please provide detailed information to help us reproduce and fix the issue. + + - type: input + id: summary + attributes: + label: "Bug Summary" + description: "Briefly describe the bug." + placeholder: "e.g., Error when saving a new entry" + validations: + required: true + + - type: textarea + id: description + attributes: + label: "Description" + description: "A clear and concise description of the bug." + placeholder: "e.g., When I click 'Save', I get a 500 error." + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: "Steps to Reproduce" + description: "Steps to reproduce the behavior." + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: "Expected Behavior" + description: "What should happen instead?" + placeholder: "e.g., The form should be saved successfully." + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: "Actual Behavior" + description: "What actually happens?" + placeholder: "e.g., A 500 error is returned with no useful error message." + validations: + required: true + + - type: input + id: version + attributes: + label: "Version" + description: "Which version of Miniflux are you using?" + placeholder: "e.g., 2.2.6" + validations: + required: true + + - type: input + id: browser + attributes: + label: "Browser" + description: "If applicable, which browser are you using? Please provide the version." + placeholder: "e.g., Chrome, Firefox, Safari" + validations: + required: false + + - type: textarea + id: logs + attributes: + label: "Relevant Logs or Error Output" + description: "Paste any relevant logs or error messages (if applicable)." + render: shell + placeholder: "e.g., Stack trace, log files, browser console logs, or console output" + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Add any other context about the problem here." + placeholder: "e.g., Screenshots, video recordings, or related issues" + validations: + required: false + + - type: checkboxes + id: agreement + attributes: + label: "Checklist" + description: "Please confirm the following:" + options: + - label: "I have searched existing issues to ensure this bug hasn't been reported before." + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 32bf7642..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: wishlist -assignees: '' - ---- - -- [ ] I have read this document: https://miniflux.app/opinionated.html#feature-request diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4abe9015 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,65 @@ +name: "Feature Request" +description: "Suggest an idea or improvement for the project" +title: "[Feature]: " +type: "Feature" +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest a feature! Please provide detailed information to help us understand and evaluate your idea. + + - type: input + id: summary + attributes: + label: "Feature Summary" + description: "Briefly describe the feature or enhancement." + placeholder: "e.g., Add dark mode support" + validations: + required: true + + - type: textarea + id: problem + attributes: + label: "What problem does this feature solve?" + description: "Explain the problem or limitation this feature would address." + placeholder: "e.g., It's difficult to use the app in low-light environments." + validations: + required: true + + - type: textarea + id: solution + attributes: + label: "Proposed Solution" + description: "Describe how you think this feature should work." + placeholder: "e.g., Add a toggle in settings to switch between light and dark mode." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: "Alternatives Considered" + description: "Have you considered other solutions or workarounds?" + placeholder: "e.g., Using browser extensions to force dark mode." + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Add any other context, screenshots, or examples to explain your request." + placeholder: "e.g., A screenshot of a similar feature in another project." + validations: + required: false + + - type: checkboxes + id: agreement + attributes: + label: "Checklist" + description: "Please confirm the following:" + options: + - label: "I have searched existing issues to ensure this feature hasn't been requested before." + required: true + - label: "I understand that feature requests are not guaranteed to be implemented." + required: true diff --git a/.github/ISSUE_TEMPLATE/feed-problems.md b/.github/ISSUE_TEMPLATE/feed-problems.md deleted file mode 100644 index a5edf2dc..00000000 --- a/.github/ISSUE_TEMPLATE/feed-problems.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feed Problems -about: Problems with a feed or a website -title: '' -labels: feed problems, triage needed -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feed_issue.yml b/.github/ISSUE_TEMPLATE/feed_issue.yml new file mode 100644 index 00000000..eab83068 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feed_issue.yml @@ -0,0 +1,84 @@ +name: "Feed/Website Issue" +description: "Report problems with a specific feed or website" +title: "[Feed Issue]: " +type: "Feed Issue" +labels: ["triage needed"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue with a feed or website! Please provide detailed information to help us diagnose and resolve the problem. + + - type: input + id: feed_url + attributes: + label: "Feed URL" + description: "Provide the URL of the feed that is not working correctly." + placeholder: "e.g., https://example.com/feed.xml" + validations: + required: true + + - type: input + id: website_url + attributes: + label: "Website URL" + description: "Provide the URL of the website." + placeholder: "e.g., https://example.com" + validations: + required: true + + - type: textarea + id: problem_description + attributes: + label: "Problem Description" + description: "Describe the issue you are experiencing with this feed." + placeholder: | + e.g., + - The feed URL returns a 403 error. + - The content is malformed. + - Images are not loading in the web ui. + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: "Expected Behavior" + description: "Describe what you expect to happen." + placeholder: "e.g., The feed should show the images correctly." + validations: + required: true + + - type: textarea + id: error_logs + attributes: + label: "Relevant Logs or Error Output" + description: "Paste any relevant logs or error messages, if available." + render: shell + placeholder: "e.g., HTTP error codes, invalid XML warnings, etc." + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Add any other context, screenshots, or related information to help us troubleshoot." + placeholder: "e.g., Is this a recurring problem? Did the feed work before?" + validations: + required: false + + - type: checkboxes + id: troubleshooting + attributes: + label: "Troubleshooting Steps" + description: "Please confirm that you have tried the following:" + options: + - label: "I have checked if the feed URL is correct and accessible in a web browser." + required: true + - label: "I have checked if the feed URL is correct and accessible with `curl`." + required: true + - label: "I have verified that the feed is valid using an RSS/Atom validator." + required: false + - label: "I have searched for existing issues to avoid duplicates." + required: true diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml new file mode 100644 index 00000000..c7e34c82 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -0,0 +1,86 @@ +name: "Proposal / RFC" +description: "Propose a significant change, or architectural decision" +title: "[Proposal]: " +type: "Proposal" +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to submit a proposal! Please provide detailed information to ensure a productive discussion. + + - type: input + id: summary + attributes: + label: "Proposal Summary" + description: "A brief summary of the proposed change or idea." + placeholder: "e.g., Refactor database schema for performance optimization" + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: "Motivation and Context" + description: "Explain the problem this proposal addresses. Why is it necessary? What are the current limitations or pain points?" + placeholder: | + e.g., + - The current database schema causes performance bottlenecks when querying large datasets. + - Adding this feature will improve scalability and reliability for large-scale use cases. + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: "Proposed Solution" + description: "Describe the proposed solution or approach. Include technical details, diagrams, and examples where possible." + placeholder: | + e.g., + - Redesign the schema to normalize tables and introduce indexing. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: "Alternatives Considered" + description: "List any alternative approaches that were considered and explain why they were rejected." + placeholder: | + e.g., + - Use Redis for caching, but it adds operational complexity. + - Stick with the current schema and optimize queries, but this has limited impact on performance. + validations: + required: false + + - type: textarea + id: impact + attributes: + label: "Impact and Risks" + description: "Describe the potential impact of this change. Highlight possible risks and backward compatibility concerns." + placeholder: | + e.g., + - May require data migration with downtime. + - Could introduce breaking changes in API responses. + - Affects core functionality, requiring extensive testing. + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: "Additional Context or References" + description: "Add any relevant context, links to related discussions, RFCs, or design documents." + placeholder: "e.g., Links to research, GitHub issues, or similar projects" + validations: + required: false + + - type: checkboxes + id: agreement + attributes: + label: "Checklist" + description: "Please confirm the following:" + options: + - label: "I have reviewed existing proposals to ensure this change hasn't been proposed before." + required: true + - label: "I agree to provide follow-up updates and maintain discussion on this proposal." + required: true