Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7af95ab

Browse files
committed
create documentation and enhancment templates
1 parent e4f58f4 commit 7af95ab

2 files changed

Lines changed: 55 additions & 0 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
---
3+
name: Documentation improvement
4+
about: Create a report to help us improve the documentation.
5+
label: Documentation
6+
---
7+
8+
<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
9+
<!--You can feel free to delete the sections that do not apply.-->
10+
11+
### Problem
12+
13+
<!--
14+
If you are referencing an existing piece of documentation or example please provide a link.
15+
16+
* I found [...] to be unclear because [...]
17+
* [...] made me think that [...] when really it should be [...]
18+
* There is no example showing how to do [...]
19+
-->
20+
21+
22+
### Suggested Improvement
23+
24+
<!--
25+
If you have an idea to improve the documentation please suggest it here
26+
27+
* This line should be be changed to say [...]
28+
* Include a paragraph explaining [...]
29+
-->
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Enhancement
3+
about: Help improve performance, usability and/or consistency.
4+
label: Enhancement
5+
---
6+
7+
### Describe the issue
8+
9+
**Summary**
10+
11+
<!-- A short 1-2 sentences that succinctly describe what could be improved -->
12+
13+
**Code example**
14+
<!--A minimal code snippet required to reproduce the bug.
15+
Please make sure to minimize the number of dependencies required, and provide
16+
any necessary plotted data
17+
-->
18+
19+
```python
20+
# paste your code here
21+
#
22+
#
23+
```
24+
25+
### Proposed fix
26+

0 commit comments

Comments
 (0)