diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..66908d5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: Bug Report +description: This template can be used to report issues with code or documentation +labels: +- kind/bug +body: +- type: markdown + attributes: + value: | + # Hi! Welcome to `e2e-framework` + + Thanks for taking the time to fill out this bug report!. + + For a smooth issue process, try to answer the following questions. + Don't worry if they're not all applicable; just try to include what you can :smile: + + If you need to include code snippets or logs, please put them in fenced code + blocks. +- type: textarea + id: observedBehavior + attributes: + label: What happened? + description: | + Please describe what is not working/broken in terms of the behavior. Please include as much detail as possible + to help identify the area of interest. + validations: + required: true + +- type: textarea + id: expectedBehavior + attributes: + label: What did you expect to happen? + description: | + Describe the behavior you were expecting to be exhibited by the framework. + validations: + required: true + +- type: textarea + id: howToReproduce + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + description: | + Please include the necessary code sample/snippets that can help reproduce the issue so that the behavior + can be analyzed better. Please use right markdown formatters to make your code more readable. + validations: + required: true + +- type: textarea + id: additionalDetail + attributes: + label: Anything elese we need to know? + +- type: dropdown + id: provider + attributes: + label: E2E Provider Used + description: Specify the provider used to setup the cluster while running your tests + multiple: false + options: + - kind + - kwok + - real cluster + validations: + required: true + +- type: input + id: frameworkVersion + attributes: + label: '`e2e-framework` Version' + validations: + required: true + +- type: textarea + id: osVersion + attributes: + label: OS version + value: | +
+ + ```console + # On Linux: + $ cat /etc/os-release + # paste output here + $ uname -a + # paste output here + + # On Windows: + C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture + # paste output here + ``` + +
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4f059754 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: This template can be used to request for a new feature or behavior for the framework +labels: +- kind/feature +body: +- type: markdown + attributes: + value: | + # Hi! Welcome to `e2e-framework` + + Thanks for taking the time to fill out this Feature Request!. + +- type: textarea + attributes: + label: What do you want to see? + description: | + Describe the feature you want and the motivation behind the request. + + Along with the details of the fature and the motivation, it would be + great if some use cases are included as well that can help us assess the + feature request better. + validations: + required: true + +- type: dropdown + attributes: + label: "Extra Labels" + description: | + If this is *also* a documentation request, etc, please select that below. + multiple: true + options: + - "/kind documentation" + - "/kind regression" + - "/kind deprecation" + - "/kind cleanup" + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..57850b46 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,69 @@ + + +#### What type of PR is this? + + + +#### What this PR does / why we need it: + +#### Which issue(s) this PR fixes: + +Fixes # + +#### Special notes for your reviewer: + +#### Does this PR introduce a user-facing change? + +```release-note +``` + + +#### Additional documentation e.g., Usage docs, etc.: + + +```docs + +``` \ No newline at end of file