Skip to content

Update templates for PR and issues #201

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 3 additions & 68 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,75 +24,10 @@ body:
- type: textarea
id: installed-packages
attributes:
label: '📦 Installed packages and configuration'
description: Describe the configuration (OS and packages that are being used)
placeholder: "Example : OS, package-lock.json..."
label: Installed packages
description: Run `python -m pip freeze` to list installed packages
placeholder: Paste the output of `python -m pip freeze` here
validations:
required: true

- type: dropdown
id: severity
attributes:
label: '🚦 Defines the severity of the bug. In the case of class-3, [specific information must be added](https://github.com/ansys-internal/QP-2-Template/blob/main/.github/ISSUE_TEMPLATE/class3.md)'
options:
- "Class 1 - Crash/Major data loss"
- "Class 2 - Serious problem"
- "Class 2 - Minor problem"
- "Class 3 - Hidden error"
default: 0
validations:
required: true

- type: input
id: support-ticket-ID
attributes:
label: '📦 Support ticket ID'
description: Give the CRM ticket ID if it's not an internal defect.
placeholder:
validations:
required: false

- type: input
id: found-in
attributes:
label: '🐞 Found in'
description: Give the version number the bug has been found.
placeholder:
validations:
required: false

- type: input
id: fixed-in
attributes:
label: '🩹 Fixed in'
description: Give the version number the bug has been fixed.
placeholder:
validations:
required: false

- type: textarea
id: root-cause
attributes:
label: 'Root cause'
description: Provide the cause of the bug.
placeholder:
validations:
required: false

- type: checkboxes
id: third-party
attributes:
label: Third Party
description:
options:
- label: This bug is introduced by a third party

- type: checkboxes
id: bug-released
attributes:
label: Released Bug
description:
options:
- label: This bug is in a released product


48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/class3.md

This file was deleted.

35 changes: 20 additions & 15 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,43 @@
name: 💡 New feature
description: features should define complete functionality that is testable and capable of adding value for the customer when shipped
description: Enhancements to the code
title: "Add ..."
labels: ["feature"]
labels: ["enhancement"]
assignees: [""]

body:

- type: markdown
attributes:
value: '# 📝 **New Feature**'

- type: textarea
id: feature-description
attributes:
label: '📝 Description of the feature'
placeholder: Describe the feature and why it is useful for the project
label: Description of the feature
placeholder: Describe what feature you devised and why it is useful for the project
validations:
required: true

- type: textarea
id: acceptanceCriteria
- type: markdown
attributes:
label: Acceptance Criteria
description: List the criteria that must be met for the story to be considered complete.
placeholder: "- Given [context], when [action], then [outcome]"
validations:
required: true
value: '# 💡 **Implementation**'

- type: textarea
id: business-value
id: implementation-description
attributes:
label: '💵 Business Value'
label: Steps for implementing the feature (optional)
placeholder: Describe how this new feature can be implemented
validations:
required: false

- type: markdown
attributes:
value: '# 🔗 **References**'

- type: textarea
id: references
attributes:
label: '🔗 Useful links and references'
label: Useful links and references
placeholder: A list of links and references to help when implementing the feature
validations:
required: false
required: false
52 changes: 0 additions & 52 deletions .github/ISSUE_TEMPLATE/story.yaml

This file was deleted.

47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/test-case.yml

This file was deleted.

50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/test-log.yml

This file was deleted.

13 changes: 4 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
# Pull Request Template

## Description
Please provide a brief description of the changes in this pull request.

## Checklist
Please complete the following checklist before submitting your pull request:
- [ ] I have tested these changes locally and verified that they work as intended.
- [ ] I have updated any documentation as needed to reflect these changes (if appropriate)
- [ ] I have verified that these changes to the best of my knowledge do not introduce any security vulnerabilities.
- [ ] Unit tests have been added (if appropriate)
- [ ] Test-cases have been added (if appropriate)
- [ ] Testing instructions have been added (if appropriate)
- [ ] I have tested these changes locally.
- [ ] I have added unit tests (if appropriate).
- [ ] I have added necessary documentation or updated existing documentation.
- [ ] I have linked the issue(s) addressed by this PR if any.
Loading