Skip to content

chore: add issue and pull request templates #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dubious90 merged 4 commits into from
Dec 4, 2020
Merged

chore: add issue and pull request templates #515

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4df26c5
chore: add issue and pull request templates
kushthedude Sep 8, 2020
3bde94d
Merge branch 'master' into temp
kushthedude Nov 6, 2020
4044a54
add link to contributing.md
kushthedude Nov 6, 2020
1516460
Merge branch 'master' into temp
kushthedude Dec 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
**Description**

This PR fixes #

@dubious90 dubious90 Sep 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we edit this language a little? I appreciate encouraging people to link to issues, but I don't think we want a 1:1 of issues to PRs, because it encourages longer PRs that are harder to review.

Maybe This PR is related to.

I'm also curious whether we should include anything about this template being a guideline, rather than set in stone. For instance, this PR is not related to an ongoing issue, and I'm not sure we would've gotten any benefit by suggesting that you should have created one.

@kushthedude kushthedude Nov 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add a comment saying if the PR is related to an issue then mention it below


**Notes for Reviewers**

<!--
Thank you for contributing to Nighthawk!

Contributing Conventions:

1. Build and test your changes before submitting a PR.

@oschaaf oschaaf Sep 8, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention familiarizing oneself with https://github.com/envoyproxy/nighthawk/blob/master/CONTRIBUTING.md ?

@kushthedude kushthedude Sep 8, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you are right, also we can mention the DCO requirement I guess.

@oschaaf oschaaf Sep 8, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, yes. There's also pre-push/pre-commit hooks in https://github.com/envoyproxy/nighthawk/tree/master/support that may help with that.

@dubious90 dubious90 Sep 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd actually argue further to Otto's point that I'd prefer we not duplicate where our contributing conventions are. I'd prefer to only reference the other markdown file here rather than specify some conventions and reference it here.

I could probably be convinced in a different direction if you feel strongly.

@kushthedude kushthedude Nov 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, we can reference the markdown file here than the other way around.


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
View file
Open in desktop
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
View file
Open in desktop
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.