From c4405129f1540c12456ef3a4ee6248901f06beca Mon Sep 17 00:00:00 2001 From: Sergio Velderrain Date: Mon, 3 Mar 2025 18:17:18 -0800 Subject: [PATCH 1/7] Adding issue forms and pull request template --- .github/ISSUE_TEMPLATE/bug_report.md | 38 --------- .github/ISSUE_TEMPLATE/bug_report.yaml | 83 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yaml | 58 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 44 ++++++++++ .../empty_pull_request.md | 0 .../infrastructure_change.md | 16 ++-- 7 files changed, 194 insertions(+), 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/empty_pull_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea78..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..4755331f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,83 @@ +name: Bug Report +description: Report a bug you've found +title: "[Bug]: " +labels: "bug" +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! +- type: dropdown + id: version + attributes: + label: What version of the icon editor are you using? + options: + - The one the came with LabVIEW + - Latest release from GitHub + - Built from source + validations: + required: true +- type: textarea + attributes: + label: LabVIEW Version + description: What LabVIEW version(s) have reported this issue? + placeholder: e.g. LabVIEW 2021 SP1 + validations: + required: true +- type: textarea + attributes: + label: OS + description: What operating system are you using? + placeholder: + validations: + required: true +- type: textarea + attributes: + label: Description / Summary + description: A brief explanation of the bug and why it is problematic. Highlight the impact or severity if applicable. + placeholder: Tell us what you see! + validations: + required: true +- type: textarea + attributes: + label: Steps to Reproduce + description: A clear, step-by-step description of how someone else can trigger the bug. Number the steps and keep them precise and minimal. + placeholder: + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: What you anticipated would happen if the software was functioning correctly. Helps distinguish the intended result from the bug. + placeholder: + validations: + required: true +- type: textarea + attributes: + label: Actual Behavior + description: The actual outcome you observed, including error messages or undesired results. Highlight differences between the actual and expected behavior. + placeholder: + validations: + required: true +- type: textarea + attributes: + label: Screenshots / Logs / Error Messages (if applicable) + description: Attach or paste screenshots, console logs, stack traces, or relevant error messages. This can be crucial for quickly identifying patterns or anomalies. + placeholder: + validations: + required: false +- type: textarea + attributes: + label: Possible Solution / Notes (optional, if you have ideas) + description: If you’ve done any initial debugging or have a hypothesis about the cause, include it. Be clear that this is your best guess, not a definitive answer. + placeholder: + validations: + required: false +- type: textarea + attributes: + label: Additional Context (optional) + description: Anything else relevant to the issue - Links to related issues, workarounds you’ve tried, changes you recently made that might have introduced the bug, etc. + placeholder: + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..cc8804a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,58 @@ +name: Feature request +description: Tell us about a new feature +title: "Feature request" +labels: "Enhancement" +body: + + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request + + - type: textarea + attributes: + label: Summary / Description + description: A short explanation of the feature you’re requesting. Focus on what the feature is and the problem it addresses. + placeholder: + validations: + required: true + + - type: textarea + attributes: + label: Motivation / Use Case + description: Explain why you need this feature or how it will be used. Describe the specific scenario(s) or challenge(s) the feature would help address. + placeholder: + validations: + required: true + + - type: textarea + attributes: + label: Proposed Solution / Feature Details + description: Provide details on how you envision the feature working. Mention any interface elements, workflows, or technical details that might be relevant. + placeholder: + validations: + required: true + + - type: textarea + attributes: + label: Alternatives / Workarounds + description: Describe any other solutions or workarounds you’ve tried or considered, and why they aren’t sufficient or optimal. + placeholder: + validations: + required: false + + - type: textarea + attributes: + label: Possible Implementation (optional) + description: If you’ve done some research or prototyping, share how the feature could be developed. Include code snippets or technical details if relevant. + placeholder: + validations: + required: false + + - type: textarea + attributes: + label: Additional Context (optional) + description: Anything else relevant to this feature request—links to related issues, references, screenshots, mockups, or other resources that help illustrate your idea. + placeholder: + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..fa57a886 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +# GitHub Issue for the Pull Request +Link to the relevant GitHub issue + +# GitHub Discussions Related to this Pull Request +List any GitHub discussion links related to this PR + +# Checklists + +Completing these checklists ensure that the contributor's PR meets our build server requirements on their first attempt. + +- [ ] I do not require assistance from NI to complete any of the following checks. +- [ ] I [pushed the feature branch](https://github.com/ni/labview-icon-editor/wiki/git#featurebranch) associated with this GitHub issue from my fork. +- [ ] I built a VI Package using the [Powershell build tool](https://github.com/ni/labview-icon-editor/wiki/automation#pwsh). +- [ ] I installed the VI Package produced by the Powershell build tool and tested my change. +- [ ] I tested my changes after [installing the VI package](https://github.com/ni/labview-icon-editor/wiki/test#localtesting). +- [ ] NI has my contributor license agreement. + +# Summary of Changes + +Provide a concise overview of what is being added, modified, or fixed in this pull request. + +# Reason for Change + +Explain the problem or need addressed by this pull request, including any relevant background information. + +# Visual Aids + +Include any visual aids that would help the reviewer gain additional context. + +# Additional Information + +Include any further details that may assist the reviewer in understanding the context of this PR. + +# Testing + +This section describes the automated and manual tests performed for this bugfix/feature. + +## Manual Tests + +Describe any manual tests conducted. + +## Unit Tests + +List the names of the new unit test files. diff --git a/.github/PULL_REQUEST_TEMPLATE/empty_pull_request.md b/.github/PULL_REQUEST_TEMPLATE/empty_pull_request.md deleted file mode 100644 index e69de29b..00000000 diff --git a/.github/PULL_REQUEST_TEMPLATE/infrastructure_change.md b/.github/PULL_REQUEST_TEMPLATE/infrastructure_change.md index 2c9313e0..0a0218b3 100644 --- a/.github/PULL_REQUEST_TEMPLATE/infrastructure_change.md +++ b/.github/PULL_REQUEST_TEMPLATE/infrastructure_change.md @@ -1,19 +1,21 @@ # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) + ## Type of change - - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) -- [ ] This change requires a documentation update - [ ] Changes to GitHub actions - [ ] Changes to Powershell scripts +## Documentation changes made to + +- [ ] LabVIEW Wiki +- [ ] Readme.md +- [ ] No documentation changes were necessary + # Checklist: -- [ ] I have tested this infrastructure change on an agent. -- [ ] My changes generate no new warnings -- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] Built a [Baseline VI Package locally](https://github.com/ni/labview-icon-editor#baseline-VI-package) locally +- [ ] Built the icon editor via a GitHub action From 5ca4b7c8e23be27c23c080933d3b2353f52819f0 Mon Sep 17 00:00:00 2001 From: sergiov-ni <156447188+svelderrainruiz@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:00:31 -0800 Subject: [PATCH 2/7] Update feature_request.yaml --- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index cc8804a7..0be8393e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,6 +1,6 @@ name: Feature request description: Tell us about a new feature -title: "Feature request" +title: "" labels: "Enhancement" body: From a917aaca1b8ae68e41f792aba15a820db3b3b2b8 Mon Sep 17 00:00:00 2001 From: sergiov-ni <156447188+svelderrainruiz@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:15:12 -0800 Subject: [PATCH 3/7] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fa57a886..c9babd74 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,10 +6,11 @@ List any GitHub discussion links related to this PR # Checklists -Completing these checklists ensure that the contributor's PR meets our build server requirements on their first attempt. +Completing these checklists ensures that your PR meets our build server requirements on the first attempt. If you're unable to complete any of the following checks, please submit your PR as a draft to the best of your ability. We will provide any clarification you may need after posting it. - [ ] I do not require assistance from NI to complete any of the following checks. -- [ ] I [pushed the feature branch](https://github.com/ni/labview-icon-editor/wiki/git#featurebranch) associated with this GitHub issue from my fork. +- [ ] I was able to checkout the feature branch associated with this issue and i pushed it into my fork +- [ ] I am making the pull request from the feature branch from my fork, onto the feature branch from NI's repo - [ ] I built a VI Package using the [Powershell build tool](https://github.com/ni/labview-icon-editor/wiki/automation#pwsh). - [ ] I installed the VI Package produced by the Powershell build tool and tested my change. - [ ] I tested my changes after [installing the VI package](https://github.com/ni/labview-icon-editor/wiki/test#localtesting). From 598bb426e41784baff5a9236347c39abf6035bdb Mon Sep 17 00:00:00 2001 From: sergiov-ni <156447188+svelderrainruiz@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:19:44 -0800 Subject: [PATCH 4/7] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c9babd74..54229af0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -39,7 +39,3 @@ This section describes the automated and manual tests performed for this bugfix/ ## Manual Tests Describe any manual tests conducted. - -## Unit Tests - -List the names of the new unit test files. From 0fdd6eacac7c3cd578c64bdfe570affb1f627f23 Mon Sep 17 00:00:00 2001 From: sergiov-ni <156447188+svelderrainruiz@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:45:08 -0800 Subject: [PATCH 5/7] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 54229af0..b21b478b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,7 +18,7 @@ Completing these checklists ensures that your PR meets our build server requirem # Summary of Changes -Provide a concise overview of what is being added, modified, or fixed in this pull request. +Provide a concise overview of what is being added, modified, or fixed in this pull request. Make an emphasis on whas was not captured on the GitHub issue, or discussion associated with this PR. # Reason for Change From 59341b4e470e7b9d6aa0ee3f9e4fef097935c9f5 Mon Sep 17 00:00:00 2001 From: Tim Robinson <60667522+crossrulz@users.noreply.github.com> Date: Tue, 4 Mar 2025 14:24:33 -0500 Subject: [PATCH 6/7] Update PULL_REQUEST_TEMPLATE.md Corrected capitalization typo --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b21b478b..81538330 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,7 +9,7 @@ List any GitHub discussion links related to this PR Completing these checklists ensures that your PR meets our build server requirements on the first attempt. If you're unable to complete any of the following checks, please submit your PR as a draft to the best of your ability. We will provide any clarification you may need after posting it. - [ ] I do not require assistance from NI to complete any of the following checks. -- [ ] I was able to checkout the feature branch associated with this issue and i pushed it into my fork +- [ ] I was able to checkout the feature branch associated with this issue and I pushed it into my fork - [ ] I am making the pull request from the feature branch from my fork, onto the feature branch from NI's repo - [ ] I built a VI Package using the [Powershell build tool](https://github.com/ni/labview-icon-editor/wiki/automation#pwsh). - [ ] I installed the VI Package produced by the Powershell build tool and tested my change. From 0e368c1949bb7b3cf4a99053f031b041114f2613 Mon Sep 17 00:00:00 2001 From: Tim Robinson <60667522+crossrulz@users.noreply.github.com> Date: Tue, 4 Mar 2025 15:17:28 -0500 Subject: [PATCH 7/7] Update PULL_REQUEST_TEMPLATE.md Updated lines 12 and 13 per comment by j-medland --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 81538330..232a71fb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,8 +9,8 @@ List any GitHub discussion links related to this PR Completing these checklists ensures that your PR meets our build server requirements on the first attempt. If you're unable to complete any of the following checks, please submit your PR as a draft to the best of your ability. We will provide any clarification you may need after posting it. - [ ] I do not require assistance from NI to complete any of the following checks. -- [ ] I was able to checkout the feature branch associated with this issue and I pushed it into my fork -- [ ] I am making the pull request from the feature branch from my fork, onto the feature branch from NI's repo +- [ ] The changes in this PR are based on the appropriate NI-repo feature branch +- [ ] I am submitting the changes in this PR to the appropriate NI-repo feature branch - [ ] I built a VI Package using the [Powershell build tool](https://github.com/ni/labview-icon-editor/wiki/automation#pwsh). - [ ] I installed the VI Package produced by the Powershell build tool and tested my change. - [ ] I tested my changes after [installing the VI package](https://github.com/ni/labview-icon-editor/wiki/test#localtesting).