Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: Report a bug you've found
title: "[Bug]: "
labels: "bug"
body:
- type: markdown
attributes:
value: |
* IMPORTANT: Before creating an issue, start the discussion about a possible bug on our [Discord Server](https://discord.gg/q4d3ggrFVA)

- type: dropdown
id: version
attributes:
label: What version of the icon editor are you using?
options:
- The one that came with LabVIEW
- Latest release from GitHub
- Built from source
- Does not apply to this issue
validations:
required: true
- type: textarea
attributes:
label: 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 (optional)
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: false
- type: textarea
attributes:
label: Expected Behavior (optional)
description: What you anticipated would happen if the software was functioning correctly. Helps distinguish the intended result from the bug.
placeholder:
validations:
required: false
- type: textarea
attributes:
label: Actual Behavior (optional)
description: The actual outcome you observed, including error messages or undesired results. Highlight differences between the actual and expected behavior.
placeholder:
validations:
required: false
- type: textarea
attributes:
label: Screenshots / Logs / Error Messages (optional)
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)
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

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
blank_issues_enabled: false

contact_links:
- name: ❓ Join Our Discord Server
url: https://discord.gg/q4d3ggrFVA
about: "Let us help you if you hit a roadblock!"

- name: 📖 Read the Docs
url: https://github.com/ni/labview-icon-editor#labview-icon-editor
about: "Check the documentation for common questions before opening an issue."

issue_templates:
- name: 🐞 Bug Report
path: bug_report.yaml
description: "Report a reproducible issue."
labels: ["bug"]

- name: 🚀 Feature Request
path: feature_request.yaml
description: "Suggest a new feature or enhancement."
labels: ["enhancement"]
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Feature request
description: Tell us about a new feature
title: "[Feature] "
labels: "Enhancement"
body:
- type: markdown
attributes:
value: |
**IMPORTANT:** Before creating an issue, start the discussion about a possible new feature on our [Discord Server](https://discord.gg/q4d3ggrFVA).

- type: textarea
attributes:
label: Summary / Description
description: A short explanation of the requested feature. Focus on what the feature is and the problem it addresses.
placeholder: "Provide a concise summary of the feature request."
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: "Describe the need for this feature and its impact."
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: "Explain how this feature should work."
validations:
required: true

- type: textarea
attributes:
label: Alternatives / Workarounds (optional)
description: Describe any other solutions or workarounds you have tried or considered, and why they were not sufficient or optimal.
placeholder: "List alternative approaches and why they don’t fully solve the problem."
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: "Provide potential implementation details."
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: "Include any extra details, references, or screenshots."
validations:
required: false
41 changes: 41 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 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 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.
- [ ] 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).
- [ ] 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. Make an emphasis on whas was not captured on the GitHub issue, or discussion associated with this PR.

# 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.
42 changes: 42 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Bug Fix PR Template

## Summary

Provide a concise description of the bug and the fix.

## Issue Link

Link to the issue being addressed.

## Root Cause Analysis

Detail the root cause of the bug and how it was identified.

## Changes

Outline the changes made to fix the bug.

## Impact

Describe any implications this fix may have on other parts of the application.

## Testing Strategy

Explain how the fix has been tested to ensure the bug is resolved without introducing new issues.

## Regression Risk

Assess the risk of regression caused by this fix and steps taken to mitigate it.

## Checklist

- [ ] The fix has been locally tested

- [ ] New unit tests have been added to prevent future regressions

- [ ] The documentation has been updated if necessary

## Additional Notes

Any further information needed to understand the fix or its impact.

35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Documentation Update PR Template

## Summary

Brief description of the documentation update and its purpose.

## Areas Affected

List the sections or pages of the documentation that are updated.

## Details

Provide detailed information about the changes made to the documentation.

## Motivation

Explain why these documentation changes are necessary.

## Review Checklist

- [ ] Spelling and grammar are correct

- [ ] All links are working and correct

- [ ] Documentation accurately reflects the current state of the project

- [ ] Changes are clearly highlighted and easy to understand

## Screenshots

Include before and after screenshots for significant visual changes, if applicable.

## Additional Notes

Any other information that might be helpful for reviewers.
Empty file.
43 changes: 43 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Feature Addition PR Template

## Summary

Briefly describe the feature being introduced.

## Rationale

Explain the reasoning behind this feature and its benefits to the project.

## Design Documentation

Link to any design documents or diagrams relevant to this feature.

## Changes

List the major changes made in this pull request.

## Impact

Discuss any potential impacts this feature may have on existing functionalities.

## Testing

Describe how the feature has been tested, including both automated and manual testing strategies.

## Screenshots/Video

Include screenshots or video demonstrating the new feature, if applicable.

## Checklist

- [ ] Code follows the project's coding standards

- [ ] Unit tests covering the new feature have been added

- [ ] All existing tests pass

- [ ] The documentation has been updated to reflect the new feature

## Additional Notes

Any additional information or context relevant to this PR.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/infrastructure_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +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.
<input type="text" id="Description" name="Description"/>

## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Changes to GitHub actions
- [ ] Changes to Powershell scripts

## Documentation changes made to

- [ ] LabVIEW Wiki
- [ ] Readme.md
- [ ] No documentation changes were necessary

# Checklist:

- [ ] 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
Loading
Loading