-
Notifications
You must be signed in to change notification settings - Fork 25
Adding issue forms and pull request template #134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c440512
Adding issue forms and pull request template
svelderrainruiz 5ca4b7c
Update feature_request.yaml
svelderrainruiz a917aac
Update PULL_REQUEST_TEMPLATE.md
svelderrainruiz 598bb42
Update PULL_REQUEST_TEMPLATE.md
svelderrainruiz 0fdd6ea
Update PULL_REQUEST_TEMPLATE.md
svelderrainruiz 59341b4
Update PULL_REQUEST_TEMPLATE.md
crossrulz 0e368c1
Update PULL_REQUEST_TEMPLATE.md
crossrulz 7fbffc8
Merge branch 'develop' into feature/github-forms-and-pr-template
svelderrainruiz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
name: Feature request | ||
description: Tell us about a new feature | ||
title: "" | ||
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
svelderrainruiz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- [ ] 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 | ||
svelderrainruiz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
svelderrainruiz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | ||
<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) | ||
- [ ] 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.