Skip to content

Improve the issue templates and pull request template. #7070

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
esc merged 3 commits into from
Jun 16, 2021
Merged

Improve the issue templates and pull request template. #7070

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdad1d5
Improve the issue templates and pull request template.
guoqiangqi May 31, 2021
6cae9d4
Add a section about checking via Gitter first when open a new bug rep…
guoqiangqi Jun 1, 2021
c796dc0
Keep templates simple
guoqiangqi Jun 3, 2021
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
62 changes: 53 additions & 9 deletions .github/ISSUE_TEMPLATE/Bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,18 @@ about: Report a bug. Not for asking general questions - see below.

<!--

Thanks for opening an issue! To help the Numba team handle your information
efficiently, please first ensure that there is no other issue present that
already describes the issue you have
(search at https://github.com/numba/numba/issues?&q=is%3Aissue).

-->
Thanks for opening an issue!
To help the Numba team handle your information efficiently,
please first check this issue via [Gitter](https://gitter.im/numba/numba) and make sure it was a bug on Numba or not.

## Reporting a bug

<!--
Then you should ensure that there is no other issue present that already describes the issue you have
(search at https://github.com/numba/numba/issues?&q=is%3Aissue).

Before submitting a bug report please ensure that you can check off these boxes:

-->

- [ ] I have checked via Gitter and make sure it is a bug on Numba.
- [ ] I have tried using the latest released version of Numba (most recent is
visible in the change log (https://github.com/numba/numba/blob/master/CHANGE_LOG).
- [ ] I have included a self contained code sample to reproduce the problem.
Expand All @@ -32,3 +29,50 @@ Please include details of the bug here, including, if applicable, what you
expected to happen!

-->
## Summary
<!-- Summarize the bug encountered concisely. -->

## Environment
<!-- Please provide your development environment here -->
- **Operating System** : Windows/Linux
- **Architecture** : x64/Arm64/PowerPC/CUDA ...
- **Python Version** : 3.8.8
- **Numba Version** : 0.53.1
- **Numpy Version** : 1.20.1
- **llvmlite Version** : 0.36.0

## Minimal Example
<!-- If possible, please create a minimal example here that exhibits the problematic behavior.
You can also link to [godbolt](https://godbolt.org). But please note that you need to set the godbolt language to Python which is default c++ and click the "Share" button in the top right-hand corner of the godbolt page where you reproduce the sample code to get the share link instead of in your browser address bar.

You can read [the guidelines on stackoverflow](https://stackoverflow.com/help/minimal-reproducible-example)
on how to create a good minimal example. -->

```python
# show your code here
```


## What is the current *bug* behavior?
<!-- Describe what actually happens. -->

## What is the expected *correct* behavior?
<!-- Describe what you should see instead. -->

## Relevant logs
<!-- Add relevant code snippets or program output within blocks marked by " ``` " -->

<!-- OPTIONAL: remove this section if you are not reporting a compilation warning issue.-->
## Warning Messages
<!-- Show us the warning messages you got! -->

<!-- OPTIONAL: remove this section if you are not reporting a performance issue. -->
## Benchmark scripts and results
<!-- Please share any benchmark scripts. -->

## Anything else that might help
<!-- It will be better to provide us more information to help narrow down the cause.
Including but not limited to the following:
- lines of code that might help us diagnose the problem.
- potential ways to address the issue.
- last known working/first broken version (release number or commit hash). -->
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ Please include details of the feature you would like to see, why you would
like to see it/the use case.

-->

## Any hints on how to implement the requested feature?
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,12 @@ Here's some guidelines to help the review process go smoothly.
Many thanks in advance for your cooperation!

-->

## Reference issue

@esc esc Jun 2, 2021

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!

<!-- You can link to a specific issue using the github syntax #<issue number> -->

## What does this implement/fix?
<!--Please explain your changes.-->

## Additional information
<!--Any additional information you think is important.-->