-
Notifications
You must be signed in to change notification settings - Fork 39
Added Issue Templates #98
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
Open
boronhub
wants to merge
11
commits into
KarthikRIyer:master
Choose a base branch
from
boronhub:issue-templates
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
a73ef23
Create 00-bug-performance-issue.md
boronhub e32c626
Update 00-bug-performance-issue.md
boronhub faef089
Create 10-build-installation-issue.md
boronhub ddf267c
Update 10-build-installation-issue.md
boronhub 5027e84
Update 10-build-installation-issue.md
boronhub b61b75f
Create 20-documentation-issue.md
boronhub 3d57c3d
Create 30-feature-request.md
boronhub a852031
Update 00-bug-performance-issue.md
boronhub 2cf079f
Update 10-build-installation-issue.md
boronhub 17206e4
Update 20-documentation-issue.md
boronhub 67f1a4f
Merge pull request #3 from KarthikRIyer/master
boronhub File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 for TensorFlow version: | ||
boronhub marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
**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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 for TensorFlow 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 for TensorFlow 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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.** |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.