diff --git a/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md b/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md new file mode 100644 index 00000000..be4bf804 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md @@ -0,0 +1,23 @@ +--- +name: Bug/Performance Issue +about: Use this template for reporting a bug or a performance issue. + +--- + +Please make sure that this is a bug. We only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. + +**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. diff --git a/.github/ISSUE_TEMPLATE/10-build-installation-issue.md b/.github/ISSUE_TEMPLATE/10-build-installation-issue.md new file mode 100644 index 00000000..5bc22bda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-build-installation-issue.md @@ -0,0 +1,21 @@ +--- +name: Build/Installation Issue +about: Use this template for reporting a build or a installation issue. + +--- + +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. + +**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. diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.md b/.github/ISSUE_TEMPLATE/20-documentation-issue.md new file mode 100644 index 00000000..e102d7d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.md @@ -0,0 +1,48 @@ +--- +name: Documentation Issue +about: Use this template for documentation related + +--- + +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. + +**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? diff --git a/.github/ISSUE_TEMPLATE/30-feature-request.md b/.github/ISSUE_TEMPLATE/30-feature-request.md new file mode 100644 index 00000000..f3391880 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30-feature-request.md @@ -0,0 +1,17 @@ +--- +name: Feature Request +about: Use this template for raising a feature request + +--- + +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. + +**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.**