Skip to content

Commit

Permalink
chore: add PR and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
crystall-bitquill committed Mar 13, 2024
1 parent 8fe5805 commit 104daa4
Show file tree
Hide file tree
Showing 5 changed files with 188 additions and 1 deletion.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: "\U0001F41B Bug Report"
description: Report a bug
title: "(short issue description)"
labels: [bug, needs-triage]
assignees: []
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: What is the problem? A clear and concise description of the bug.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: |
What did you expect to happen?
validations:
required: true
- type: input
id: connection-config
attributes:
label: What plugins are used? What other connection properties were set?
validations:
required: true
- type: textarea
id: current
attributes:
label: Current Behavior
description: |
What actually happened?
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction Steps
description: |
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
For more complex issues provide a repo with the smallest sample that reproduces the bug.
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Possible Solution
description: |
Suggest a fix/reason for the bug
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Information/Context
description: |
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
validations:
required: false

- type: input
id: driver-version
attributes:
label: The AWS Advanced NodeJs Wrapper version used
validations:
required: true
- type: input
id: node-version
attributes:
label: Node version used
description: Output of `node -v`
validations:
required: true
- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: "\U0001F4D5 Documentation Issue"
description: Report an issue in the README.md
title: "(short issue description)"
labels: [documentation, needs-triage]
assignees: []
body:
- type: textarea
id: description
attributes:
label: Describe the issue
description: A clear and concise description of the issue.
validations:
required: true

- type: textarea
id: links
attributes:
label: Links
description: |
Include links to affected documentation page(s).
validations:
required: true
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: "\U0001F680 Feature Request"
description: Suggest an idea for this project
title: "(short issue description)"
labels: [enhancement, needs-triage]
assignees: []
body:
- type: textarea
id: description
attributes:
label: Describe the feature
description: A clear and concise description of the feature you are proposing.
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: |
Why do you need this feature? For example: "I'm always frustrated when..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
validations:
required: false
- type: textarea
id: other
attributes:
label: Other Information
description: |
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
validations:
required: false
- type: checkboxes
id: ack
attributes:
label: Acknowledgements
options:
- label: I may be able to implement this feature request
required: false
- label: This feature might incur a breaking change
required: false

- type: input
id: driver-version
attributes:
label: The AWS Advanced NodeJs Wrapper version used
validations:
required: true

- type: input
id: node-version
attributes:
label: Node version used
description: Output of `node -v`
validations:
required: true

- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Summary

<!--- General summary / title -->

### Description

<!--- Details of what you changed -->

### Additional Reviewers

<!-- Any additional reviewers -->

### By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 change: 0 additions & 1 deletion tests/integration/container/tests/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import { ProxyHelper } from "./utils/proxy_helper";

/* eslint-disable @typescript-eslint/no-unused-vars */
export default async (globalConfig: any, projectConfig: any) => {
console.log("Set up");
// console.log(globalConfig);

const info = (await TestEnvironment.getCurrent()).info;
Expand Down

0 comments on commit 104daa4

Please sign in to comment.