Skip to content

Commit

Permalink
adding some comments on the github issue template, to test if it's wo…
Browse files Browse the repository at this point in the history
…rking
  • Loading branch information
BDonnot committed May 29, 2020
1 parent 478eb59 commit 433e3b2
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
11 changes: 10 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,35 @@ assignees: ''
- Additional system information

## Bug description
A clear and concise description of what the bug is.
<!--A clear and concise description of what the bug is.-->

## How to reproduce
<!--Explain in detail how to reproduce your issue. The easier it will be for us to
reproduce it, the faster we will be able to work on this.-->

### Command line
<!--Ideally, if we execute the following command, the bug will directly be reproduced.
Here put the command line we have to execute-->
```bash
# command line used if any
```

### Code snippet
<!--Expose the python code you want us to test-->
```python
import grid2op

... # Some code
```

## Current output
<!--Describe the output you have-->
```
The output of the code snippet above
```

## Expected output
<!--Describe the output you desire-->
```
The expected output and/or expected behavior description
```
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ assignees: ''
---

## Documentation issue description
A description of what the problem/suggestion is.
<--A description of what the problem/suggestion is.-->

## Suggested modifications
<--Be as concise and clear as possible.
Ideally we could directly copy paste this code in grid2op documentation / notebook etc.
-->
```
Documentation issues are low priority.
Please provide your suggested modifications to increase processing speed.
Expand Down

0 comments on commit 433e3b2

Please sign in to comment.