diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index e98875d..5a936d4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,64 +1,54 @@ -name: 🐛 Bug Report -description: Report a reproducible bug -labels: ["bug"] -projects: ["soujava/3"] +name: Bug report 🐞 +description: File a bug report +title: "[Bug] " +labels: bug body: - - type: markdown + - type: input + id: existing-issue attributes: - value: | - Please provide all the information requested. Issues that do not follow this format are likely to stall. - - Please test using the latest POM Editor Maven Plugin release to make sure your issue has not already been fixed: https://github.com/soujava/pom-editor-maven-plugin/releases - - type: textarea - id: description - attributes: - label: Description - description: | - Please provide a clear and concise description of what the bug is. - Include screenshots if needed. - validations: - required: true + label: Is there an existing issue for this? + description: Please provide a link to the existing issue if applicable. If none exists, leave this blank. + placeholder: "Paste the issue link here (if available)" - type: textarea - id: evidences + id: what-happened attributes: - label: Evidences - description: | - Please, provide a link to a repository on GitHub, or provide a minimal code example that reproduces the problem. - You may provide a screenshot of the application if you think it is relevant to your bug report. - Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve + label: Describe the Bug + description: A concise description of what you are experiencing. + placeholder: Tell us what you see! validations: required: true - - type: textarea - id: steps-to-produce + id: expected-behaviour attributes: - label: Steps To Reproduce - description: | - Please, provide a detailed list of steps that reproduce the issue. + label: Expected Behavior + description: A clear and concise description of what you expected to happen. validations: required: true - - type: textarea - id: expected-results + id: reproduction-steps attributes: - label: Expected Results + label: Steps to Reproduce & Screenshots 📸 description: | - Describe what you expected to happen. - validations: - required: false - + Please list the steps to reproduce this issue along with relevant screenshots. + This helps us diagnose and resolve the bug more efficiently. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error message... + + (Attach screenshots or GIFs below to demonstrate the issue) - type: textarea - id: solution-ideas + id: environment-configuration attributes: - label: Any idea for solving this issue? - description: | - Please, share with us your ideas for solving this issue if you have any. - validations: - required: false - - - type: markdown + label: Environment and Configuration + description: Provide details about your system and environment (e.g., OS, browser, dependencies, versions). + - type: checkboxes + id: terms attributes: - value: | - ### Code of Conduct - By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/soujava/pom-editor-maven-plugin/blob/main/CODE_OF_CONDUCT.adoc) - + label: Record + options: + - label: "I have read the Contributing Guidelines" + required: true + - label: "I have starred the repository" + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yaml b/.github/ISSUE_TEMPLATE/documentation_update.yaml new file mode 100644 index 0000000..c49c594 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.yaml @@ -0,0 +1,57 @@ +name: Documentation Update 📝 + +description: Improve Documentation +title: "[Documentation Update]: " +labels: 'documentation' +body: + - type: input + id: existing-issue-link + attributes: + label: Link to Existing Issue + description: If an issue already exists for this update, please provide the link. Otherwise, leave it blank. + placeholder: "https://github.com/owner/repository/issues/123" + - type: textarea + id: issue-description + attributes: + label: Issue Description + description: Please provide a clear description of the documentation update you are suggesting. + placeholder: Describe the improvement or correction you'd like to see in the documentation. + validations: + required: true + - type: textarea + id: suggested-change + attributes: + label: Suggested Change + description: Provide details of the proposed change to the documentation. + placeholder: Explain how the documentation should be updated or corrected. + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Why is this documentation update necessary or beneficial? + placeholder: Explain the importance or reasoning behind the suggested change. + validations: + required: false + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgently do you believe this documentation update is needed? + options: + - High + - Medium + - Low + default: 0 + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I have read the Contributing Guidelines" + required: true + - label: "I have starred the repository" + required: false # Made optional so users are not forced to star the repo diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4c236d0..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature request -about: Suggest a new idea for POM Editor Maven Plugin -title: '' -labels: '' -assignees: '' -projects: 'soujava/3' - ---- - - -## Use case - - - -## Proposal - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..0cd3e58 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,59 @@ +name: Feature Request ✨ +description: Suggest a feature +title: "[Feature Request] " +labels: enhancement +body: + - type: input + id: existing-issue + attributes: + label: Is there an existing issue for this? + description: "If there is an existing issue related to this feature request, please provide the link. Otherwise, you may leave this blank." + placeholder: "https://github.com/owner/repository/issues/123" + - type: textarea + id: feature-description + attributes: + label: Feature Description + description: Please provide a detailed description of the feature you are requesting. + placeholder: Describe the new feature or enhancement you'd like to see. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Use Case + description: How would this feature enhance your use of the project? + placeholder: Describe a specific use case or scenario where this feature would be beneficial. + validations: + required: true + - type: textarea + id: benefits + attributes: + label: Benefits + description: What benefits would this feature bring to the project or community? + placeholder: Explain the advantages of implementing this feature. + - type: textarea + id: screenshots + attributes: + label: Add Screenshots + description: If applicable, add screenshots or visual references. + - type: dropdown + id: priority + attributes: + label: Priority + description: How important is this feature to you? + options: + - High + - Medium + - Low + default: 0 + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I have read the Contributing Guidelines" + required: true + - label: "I have starred the repository" + required: false # Made optional so users are not forced to star the repo diff --git a/.github/ISSUE_TEMPLATE/new-goal-proposal.yaml b/.github/ISSUE_TEMPLATE/new-goal-proposal.yaml deleted file mode 100644 index bad6383..0000000 --- a/.github/ISSUE_TEMPLATE/new-goal-proposal.yaml +++ /dev/null @@ -1,51 +0,0 @@ -name: New Goal Proposal -title: '[New Goal Proposal]: ' -description: Open a goal request -labels: ["enhancement","proposal","question","help wanted"] -body: - - type: markdown - attributes: - value: | - Please provide all the required information requested. Goal requests that do not follow this format are likely to stall. - - - type: textarea - id: purpose-goal - attributes: - label: What is the purpose of the new goal? - description: | - Please provide a clear and concise purpose for the goal that you're requesting. - Feel free to Include screenshots if needed. - validations: - required: true - - - type: textarea - id: expected-behavior-and-output - attributes: - label: What is the expected behavior and output of the new goal? - description: | - Please provide the following information (Feel free to Include screenshots if needed): - - the goal syntax; - - the required inputs; - - the expected behavior; - - the expected output; - value: | - ### Given the pom: - ```xml - - - 4.0.0 - anyGroupId - anyArtifactId - 0.0.1-SNAPSHOT - pom - - ``` - ### When execute: - ```sh - mvn pom-editor: [-DnewParams=?] - ``` - ### Expected output or result: - - validations: - required: true - diff --git a/.github/ISSUE_TEMPLATE/other.yaml b/.github/ISSUE_TEMPLATE/other.yaml new file mode 100644 index 0000000..579cbf4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yaml @@ -0,0 +1,25 @@ +name: Other +description: Use this for any other issues. Please do NOT create blank issues +title: '[OTHER] write a small description here' +body: + - type: textarea + id: issuedescription + attributes: + label: What would you like to share? + description: Provide a clear and concise explanation of your issue. + validations: + required: true + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: 'Checklist 🚀' + options: + - label: "I checked and didn't find a similar issue" + required: true + + - label: 'I have read the Contributing Guidelines' + required: true + + - label: 'I am willing to work on this issue (blank for no).' + required: false