Skip to content

Commit

Permalink
chore: add issue and pull request templates (#515)
Browse files Browse the repository at this point in the history
* chore: add issue and pull request templates

Signed-off-by: Kush Trivedi <kushthedude@gmail.com>

* add link to contributing.md

Signed-off-by: Kush Trivedi <kushthedude@gmail.com>
  • Loading branch information
kushthedude authored Dec 4, 2020
1 parent 31b7857 commit 2afa57b
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
**Description**

<!--
If this PR is related to an open issue, please mention the issue below.
-->

This PR is related to #


**Notes for Reviewers**

<!--
Thank you for contributing to Nighthawk!
Please read contributing guidelines https://github.com/envoyproxy/nighthawk/blob/master/CONTRIBUTING.md by following the community's contribution conventions upfront, the review process will be accelerated and your PR merged more quickly.
-->
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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).
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 2afa57b

Please sign in to comment.