generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #298 from harshanarayana/feature/enable-issue-temp…
…altes enable issue and pr templates
- Loading branch information
Showing
3 changed files
with
196 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,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: | | ||
<details> | ||
```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 | ||
``` | ||
</details> |
This file contains 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,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" | ||
|
This file contains 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,69 @@ | ||
<!-- Thanks for sending a pull request! Here are some tips for you: | ||
1. If this is your first time, please read our contributor guidelines: https://git.k8s.io/community/contributors/guide/first-contribution.md#your-first-contribution and developer guide https://git.k8s.io/community/contributors/devel/development.md#development-guide | ||
2. Please label this pull request according to what type of issue you are addressing, especially if this is a release targeted pull request. For reference on required PR/issue labels, read here: | ||
https://git.k8s.io/community/contributors/devel/sig-release/release.md#issuepr-kind-label | ||
3. Ensure you have added or ran the appropriate tests for your PR: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md | ||
4. If you want *faster* PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews | ||
5. If the PR is unfinished, see how to mark it: https://git.k8s.io/community/contributors/guide/pull-requests.md#marking-unfinished-pull-requests | ||
--> | ||
|
||
#### What type of PR is this? | ||
|
||
<!-- | ||
Add one of the following kinds: | ||
/kind bug | ||
/kind cleanup | ||
/kind documentation | ||
/kind feature | ||
Optionally add one or more of the following kinds if applicable: | ||
/kind api-change | ||
/kind deprecation | ||
/kind failing-test | ||
/kind flake | ||
/kind regression | ||
--> | ||
|
||
#### What this PR does / why we need it: | ||
|
||
#### Which issue(s) this PR fixes: | ||
<!-- | ||
*Automatically closes linked issue when PR is merged. | ||
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. | ||
_If PR is about `failing-tests or flakes`, please post the related issues/tests in a comment and do not use `Fixes`_* | ||
--> | ||
Fixes # | ||
|
||
#### Special notes for your reviewer: | ||
|
||
#### Does this PR introduce a user-facing change? | ||
<!-- | ||
If no, just write "NONE" in the release-note block below. | ||
If yes, please enter the details of what chanages are being introduced: | ||
Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required". | ||
For more information on release notes see: https://git.k8s.io/community/contributors/guide/release-notes.md | ||
--> | ||
```release-note | ||
``` | ||
|
||
|
||
#### Additional documentation e.g., Usage docs, etc.: | ||
|
||
<!-- | ||
When adding links which point to resources within git repositories, like | ||
KEPs or supporting documentation, please reference a specific commit and avoid | ||
linking directly to the master branch. This ensures that links reference a | ||
specific point in time, rather than a document that may change over time. | ||
See here for guidance on getting permanent links to files: https://help.github.com/en/articles/getting-permanent-links-to-files | ||
Please use the following format for linking documentation: | ||
- [KEP]: <link> | ||
- [Usage]: <link> | ||
- [Other doc]: <link> | ||
--> | ||
```docs | ||
``` |