Skip to content
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.

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

Added Issue Templates #98

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/00-bug-performance-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug/Performance Issue
about: Use this template for reporting a bug or a performance issue.

---

<em>Please make sure that this is a bug. We only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**System information**
- Have I written custom code (as opposed to using a stock example script provided in SwiftPlot):
- OS Platform and Distribution (e.g., Linux Ubuntu 18.04):
- Swift version:


**Describe the current behavior**

**Describe the expected behavior**

**Code to reproduce the issue**
Provide a reproducible test case that is the bare minimum necessary to generate the problem.

**Other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/10-build-installation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Build/Installation Issue
about: Use this template for reporting a build or a installation issue.

---

<em>Please make sure that this is a build/installation issue. We only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**System information**
- Have I written custom code (as opposed to using a stock example script provided in SwiftPlot):
- OS Platform and Distribution (e.g., Linux Ubuntu 18.04):
- Swift version:


**Describe the problem**

**Provide the exact sequence of commands / steps that you executed before running into the problem**


**Any other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/20-documentation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Documentation Issue
about: Use this template for documentation related

---

<em>Please make sure that this is a documentation issue. We only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**System information**
- Have I written custom code (as opposed to using a stock example script provided in SwiftPlot):
- OS Platform and Distribution (e.g., Linux Ubuntu 18.04):
- Swift version:


## Description of issue (what needs changing):

### Clear description

For example, why should someone use this method? How is it useful?

### Correct links

Is the link to the source code correct?

### Parameters defined

Are all parameters defined and formatted correctly?

### Returns defined

Are return values defined?

### Raises listed and defined

Are the errors defined?

### Usage example

Is there a usage example?


### Request visuals, if applicable

Are there currently visuals? If not, will it clarify the content?

### Submit a pull request?

Are you planning to also submit a pull request to fix the issue?
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/30-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature Request
about: Use this template for raising a feature request

---

<em>Please make sure that this is a feature request. We only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**Basic Information**
- Are you willing to contribute it (Yes/No):


**Describe the feature and the current behavior/state.**

**Who will benefit with this feature?**

**Any Other info.**