-
Notifications
You must be signed in to change notification settings - Fork 83
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.
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
chore: add issue and pull request templates #515
Conversation
Signed-off-by: Kush Trivedi <kushthedude@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this!
I'm curious, is there a way to preview the effects of this before merging?
I have a suspicion I know the answer to that (no), but I thought lets ask anyway.
As for the substance of this PR, leaving one ask, other than that this LGTM.
I'll defer to @dubious90 for final review.
|
||
Contributing Conventions: | ||
|
||
1. Build and test your changes before submitting a PR. |
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
/assign dubious90 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks awesome. Thanks! Just a couple suggestions
@@ -0,0 +1,16 @@ | |||
**Description** | |||
|
|||
This PR fixes # |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
|
||
Contributing Conventions: | ||
|
||
1. Build and test your changes before submitting a PR. |
There was a problem hiding this comment.
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 kindly pinging this PR, there is an open question in the review comments |
Signed-off-by: Kush Trivedi <kushthedude@gmail.com>
/retest |
🔨 rebuilding |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
/retest |
🔨 rebuilding |
/retest |
🔨 rebuilding |
Ready for merging, blocked on the clang_tidy flake which we are planning to remove temporarily in the near future (#570). |
Please merge from master to remove the hard block on clang_tidy. |
Done @mum4k |
Signed-off-by: Kush Trivedi kushthedude@gmail.com
/cc @oschaaf