Skip to content

Improve the issue templates and pull request template. - #7070

Merged
esc merged 3 commits into
numba:masterfrom
guoqiangqi:issue_pr_template
Jun 16, 2021
Merged

esc merged 3 commits into
numba:masterfrom
guoqiangqi:issue_pr_template

Conversation

@guoqiangqi

Copy link
Copy Markdown
Contributor

Provide better issue templates and pull request template.

@esc

esc commented May 31, 2021

Copy link
Copy Markdown
Member

@guoqiangqi thank you for your suggestion. We will have to discuss this tomorrow in the developer meeting, but personally I am +1 on this.

Also, could you maybe add a section about checking via Gitter first? if unsure if this is a bug or not? Since the requested answers in the new template are somewhat more involved and I'd like to largely prevent want someone to go through all of the fact gathering to report what then turns out to be a user-error or similar.

@esc esc added 3 - Ready for Review discussion An issue requiring discussion labels May 31, 2021
…ort issue, and keep the original check list.
@guoqiangqi

Copy link
Copy Markdown
Contributor Author

@guoqiangqi thank you for your suggestion. We will have to discuss this tomorrow in the developer meeting, but personally I am +1 on this.

Also, could you maybe add a section about checking via Gitter first? if unsure if this is a bug or not? Since the requested answers in the new template are somewhat more involved and I'd like to largely prevent want someone to go through all of the fact gathering to report what then turns out to be a user-error or similar.

@esc Sorry about the delay, i have updated this part of code.

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated

-->

## Reference issue

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.

This is to keep!

@esc

esc commented Jun 2, 2021 •

Copy link
Copy Markdown
Member

@guoqiangqi thank you again for submitting this improvement! We had a conversation about this in the developer meeting yesterday and it turns out, we had refactored the pull-request template to make it simpler! We do see your intention to improve the Numba pull-request and issue-reporting -- but we feel this may be asking a bit too much from our users. I think the main questions that need to be answered are:

  • What did you try?
  • What did you expect?
  • What happened instead?

And then have a runnable (including imports, the code in question and a line or lines to execute it) script to reproduce the bug. Anything else, we can always ask about or request the output of numba -s. We do have a first-port-of-call rota in place
during weekdays so our issue response times are reasonably short and we know what else to ask for.

Anyhow , the part about "reference an existing issue, if it exists" was well received and will be merged, so that's good! So, I think @guoqiangqi you may modify the PR to include the suggestion about adding a link to a PR and we will merge that!

Thank you again for you efforts on this front and your help to improve Numba!

@guoqiangqi

Copy link
Copy Markdown
Contributor Author

@esc Agree with you, we should not make the templates complex , it may make issue reporting more complicated. New code has been uploaded.

@gmarkall gmarkall added 4 - Waiting on reviewer Waiting for reviewer to respond to author and removed 3 - Ready for Review labels Jun 3, 2021
@stuartarchibald stuartarchibald added this to the Numba 0.54 RC milestone Jun 16, 2021

@esc esc left a comment

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.

LGTM, thank you!

@stuartarchibald

Copy link
Copy Markdown
Contributor

@guoqiangqi Congratulations on your first contribution to Numba!

@esc thanks for reviewing.

@stuartarchibald stuartarchibald added 5 - Ready to merge Review and testing done, is ready to merge Effort - medium Medium size effort needed and removed 4 - Waiting on reviewer Waiting for reviewer to respond to author discussion An issue requiring discussion labels Jun 16, 2021
@esc
esc merged commit 84f2b5a into numba:master Jun 16, 2021
@guoqiangqi
guoqiangqi deleted the issue_pr_template branch July 19, 2021 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 - Ready to merge Review and testing done, is ready to merge Effort - medium Medium size effort needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants