From 4df26c59a9ca2af1a97b39fa3dcabad44924c1bb Mon Sep 17 00:00:00 2001 From: Kush Trivedi Date: Tue, 8 Sep 2020 18:21:06 +0530 Subject: [PATCH 1/2] chore: add issue and pull request templates Signed-off-by: Kush Trivedi --- .../ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++ .github/ISSUE_TEMPLATE/bug.md | 32 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++ 3 files changed, 65 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..28138a877 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +**Description** + +This PR fixes # + +**Notes for Reviewers** + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 000000000..6ee5fa021 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,32 @@ +--- +name: Non-{crash,security} bug +about: Bugs which are not crashes, DoS or other security issue +title: '' +labels: bug,triage +assignees: '' + +--- + +*Title*: *One line description* + +*Description*: +>What issue is being seen? Describe what should be happening instead of +the bug, for example: Nighthawk should not crash, the expected value isn't +returned, etc. + +*Reproduction steps*: +> Include sample requests, environment, etc. All data and inputs +required to reproduce the bug. + +>**Note**: If there are privacy concerns, sanitize the data prior to +sharing. + +*Logs*: +>Include the Nighthawk logs. + +>**Note**: If there are privacy concerns, sanitize the data prior to +sharing. + +*Call Stack*: +> If the Envoy binary is crashing, a call stack is **required**. +Please refer to the [Bazel Stack trace documentation](https://github.com/envoyproxy/envoy/tree/master/bazel#stack-trace-symbol-resolution). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..ef966b857 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement,triage +assignees: '' + +--- + +*Title*: *One line description* + +*Description*: +>Describe the the desired behavior, what scenario it enables and how it +would be used. + +[optional *Relevant Links*:] +>Any extra documentation required to understand the issue. \ No newline at end of file From 4044a545f4f86ed3dcf19f0035f35b6356835e6b Mon Sep 17 00:00:00 2001 From: Kush Trivedi Date: Fri, 6 Nov 2020 08:33:18 +0530 Subject: [PATCH 2/2] add link to contributing.md Signed-off-by: Kush Trivedi --- .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md index 28138a877..a91d54f04 100644 --- a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,16 @@ **Description** -This PR fixes # + + +This PR is related to # + **Notes for Reviewers** \ No newline at end of file