Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Dec 14, 2019
1 parent 529ac06 commit 3e296e7
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report
about: Report a bug
title: ''
labels: bug
assignees: ''

---

* Krotov version:
* Python version:
* Operating System:

### Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

```
Paste the command(s) you ran and the output. Using markdown formatting
If there was a crash, please include the traceback here.
```
Avoid screenshots. A great way to report a bug is to create a Jupyter notebook, upload it to http://gist.github.com and link it here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---


16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Question
about: Ask a question
title: ''
labels: ''
assignees: ''

---

Is there something you cannot figure out how to do?

* Krotov version:
* Python version:
* Operating System:

Preferably, create a Jupyter notebook that illustrates what you're trying to do, upload it to http://gist.github.com, and link it here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/related-software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Related Software
about: Report a related software project
title: ''
labels: documentation
assignees: ''

---

The following project should be added to `krotov`'s documentation as "Related Software":

**Project Name**:

**Project URL**:

**Programming Language**:

**One-line project description**:

How is the software related to `krotov`? Is it an implementation of optimal quantum control? If so which optimal control methods? If a new method, are there papers describing the method or its implementation?

0 comments on commit 3e296e7

Please sign in to comment.