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
  •  
  •  
  •  
23 changes: 23 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
#* @global-owner1 @global-owner2

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
#*.js @js-owner #This is an inline comment.

# In this example, @octocat owns any file in an apps directory
# anywhere in your repository.
#apps/ @octocat

pyproject.toml @margalva

# define an owner for the CODEOWNERS file itself
/.github/ @margalva
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: 🐞 Bug
description: Fill a bug report here
title: "Bug located in ..."
type: "Bug"
labels: [""]
assignees: [""]

body:
- type: textarea
id: bug-description
attributes:
label: '🐞 Description of the bug'
placeholder: Describe what bug you encountered and what should have happened.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: '📝 Steps to reproduce'
placeholder: Please write the steps to reproduce the issue.
validations:
required: true

- 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..."
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: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/class3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
> This section SHALL be added at the end of a Released Class 3 bug.

### Class 3 Only - Description

> Description of a bug for the customer audience

### Class 3 Only - Suggested User Action

> Suggest what the end user should do to avoid the bug.

### Class 3 Only - Defect ID (Int)


### Class 3 Only - Management Reviewer


### Class 3 Only - Management Review Date (datetime)

> Write with this date format mm/dd/YY

### Class 3 Only - Doc Reviewer


### Class 3 Only - Doc Review Date (datetime)

> Write with this date format mm/dd/YYYY

### Class 3 Only - Technical Reviewer


### Class 3 Only - Technical Review Date (datetime)

> Write with this date format mm/dd/YYYY

### Class 3 Only - Affected Program


### Class 3 Only - Affected Physics Area


### Class 3 Only - Keywords


### Class 3 Only - First Incorrect Version


### Class 3 Only - Corrected In Version

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/concern.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: ⚠️ Concern
description: Describe the concern here
title: ""
labels: ["concern"]
assignees: [""]

body:
- type: textarea
id: concern-description
attributes:
label: '⚠️ Description of the concern'
placeholder: Describe the concern and what should be done to resolve it, if possible.
validations:
required: true
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 💡 New feature
description: features should define complete functionality that is testable and capable of adding value for the customer when shipped
title: "Add ..."
labels: [""]
assignees: [""]
type: "Feature"

body:

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

- type: textarea
id: acceptanceCriteria
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

- type: textarea
id: business-value
attributes:
label: '💵 Business Value'
validations:
required: false

- type: textarea
id: references
attributes:
label: '🔗 Useful links and references'
validations:
required: false
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/story.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 📖 User Story
description: Stories are pieces of work done in one iteration, they can be of several types, technical, functional...
title: "[User Story]: <Title of the user story>"
type: "Story"
labels: [""]

body:
- type: textarea
id: description
attributes:
label: User Story Description
description: Describe the user story in detail, including the desired outcome.
placeholder: "As a [type of user], I want [an action] so that [a benefit/a value]"
validations:
required: true

- type: textarea
id: acceptanceCriteria
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

- type: textarea
id: notes
attributes:
label: Additional Links
description: Links to Test Cases / Features / Other User Stories
placeholder: "[Issue #1](https://github.com/ansys-internal/QP-2-Template)"
validations:
required: false

- type: dropdown
id: third-party
attributes:
label: Requires new or update to third party ? If "yes" add the name(s) and the version(s) of the Third Party Software.
options:
- "No"
- "Yes, new"
- "Yes, update"
default: 0
validations:
required: true

- type: textarea
id: third-party-desc
attributes:
label: Name and Version for Third Parties
description: Name and version of the integrated third party software components
placeholder:
validations:
required: false
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/test-case.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 🧪 Test Case
description: Description of a test scenario covering a story or a feature.
title: 'Add...'
labels: [""]
assignees: [""]
type: "Test Case"

body:
- type: textarea
id: description
attributes:
label: "📝 Description"
description: "Provide a clear and concise description of the test case."
placeholder: "Enter the description here"
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: "📜 Steps"
description: "List the detailed actions to reproduce the test scenario."
placeholder: "1. Step 1..."
validations:
required: true

- type: textarea
id: expected-results
attributes:
label: "🧪 Expected Results"
description: "Describe the expected outcome or behavior at the end of the test case."
placeholder: "Enter the expected results here"
validations:
required: true

- type: textarea
id: test-data
attributes:
label: "📁 Test Data"
description: "Mention any specific data or inputs required for this test case."
placeholder: "- Data 1..."

- type: textarea
id: related-issues
attributes:
label: "🔗 Related Issues"
description: "Link to any related stories, features or pull requests, if applicable."
placeholder: "- Issue 1..."
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/test-log.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 📊 Test Log
description: "Template for logging the results of a manually executed test case."
title: "[Test Log]: <Test Name>"
labels: [""]
assignees: [""]
type: "Test Log"

body:
- type: input
id: related-issues
attributes:
label: "🔗 Related Test Case"
description: "Link to the Test Case this manual result is created from."
placeholder: "- Issue 1..."
validations:
required: true

- type: textarea
id: test-results
attributes:
label: "📊 Test Results"
description: "Log the results of each test step in the form of a table. Use `|` to separate columns and `-` for table headers."
placeholder: "| Test Step | Expected Result | Actual Result | Status |\n|-----------|-----------------|---------------|--------|\n| Step 1 | Expected 1 | Actual 1 | Pass |\n| Step 2 | Expected 2 | Actual 2 | Fail |"
validations:
required: true

- type: textarea
id: build-name
attributes:
label: "Build Tested"
description: "Name/Number of the build the test has been executed"
placeholder: "Enter the build number here and configuration information"
validations:
required: true

- type: textarea
id: platform
attributes:
label: "Platform"
description: "OS and version, Browser and version, Job scheduler and versions as relevant"
placeholder: "Example : Windows Server 22/Red Hat 8.6...Chrome v117"
validations:
required: true

- type: checkboxes
id: overall-test-passed
attributes:
label: Overall result
description:
options:
- label: Test passed
Loading
Loading