-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
74 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,32 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
about: Create a report to help us improve | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
#### Description | ||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
#### Way to reproduce | ||
|
||
```python | ||
>>> import kikuchipy as kp | ||
>>> import numpy as np | ||
>>> s = kp.signals.EBSD(np.zeros((10, 10, 10, 10))) | ||
>>> # The bug here... | ||
``` | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
#### Version information | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
```python | ||
# Paste the output of the following python commands | ||
import sys; print(sys.version) | ||
import platform; print(platform.platform()) | ||
import kikuchipy; print("kikuchipy version: {}".format(kikuchipy.__version__)) | ||
``` | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
```python | ||
# Your output here | ||
``` | ||
|
||
**Additional context** | ||
Add any other context about the problem here. | ||
#### Expected behaviour | ||
<!-- A clear and concise description of what you expected to happen. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,16 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
#### Is your feature request related to a problem? Please describe. | ||
<!-- A clear and concise description of what the problem is. --> | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
#### Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
#### Describe alternatives you've considered | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. | ||
#### Additional context | ||
<!-- Add any other context or screenshots about the feature request here. --> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
<!-- Requirements --> | ||
<!-- * Read the contributor guide: https://kikuchipy.readthedocs.io/en/latest/contributing.html --> | ||
<!-- * Fill out the template. It helps the review process and is useful to summarise the PR. --> | ||
<!-- * This template can be updated during the progression of the PR to summarise its status --> | ||
|
||
#### Description | ||
<!-- What does this pull request (PR) do? Why is it necessary? --> | ||
<!-- A few sentences and/or a bullet list. --> | ||
|
||
#### Type of change | ||
<!-- Please delete options that are not relevant. --> | ||
- [ ] Bug-fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
#### Progress | ||
- [ ] Change(s) implemented (can be split into several points) | ||
- [ ] Docstrings updated (if appropriate) | ||
- [ ] Code is commented, particularly in hard-to-understand areas (if appropriate) | ||
- [ ] Documentation and/or user guide updated (if appropriate) | ||
- [ ] Tests have been written | ||
- [ ] Ready for review! | ||
|
||
#### How has this been tested? | ||
<!-- Please describe the tests that you ran to verify your changes. --> | ||
- [ ] example: the test suite for my feature covers cases x, y, and z | ||
- [ ] example: all tests pass with my change | ||
|
||
#### Minimal example of the bug fix or new feature | ||
<!-- Note that this example can be useful to update the user guide with! --> | ||
|
||
```python | ||
>>> import kikuchipy as kp | ||
>>> import numpy as np | ||
>>> s = kp.signals.EBSD(np.zeros((10, 10, 10, 10))) | ||
>>> # Your new feature... | ||
``` | ||
|
||
#### References | ||
<!-- What resources, documentation, and guides were used in the creation of this PR? --> | ||
<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" --> |